dotloop
Advanced tools
Readme
A node.js client for the dotloop API. This module supports all endpoints that were published in the Dotloop API Developer Guide, dated 2014-08-28.
A dotloop account has one or more profiles. For example, a user might have admin access to a brokerage profile, an office profile, and a personal profile. Each profile has it’s own set of loops and templates. Most calls to the dotloop API require you to specify a profile.
When specifying a loop within the dotloop API you will always a loop view id, not a loop id. In fact, just forget that the loop id exists. We know it’s confusing, we’re sorry! There’s a technical reason why this is but it’s very boring. We’ll spare you the details.
To get an API key your dotloop user must have access to the API functionality. To generate a key navigate to the “My Account” link on the profile list in dotloop.
npm install dotloop
The Dotloop API requires an access token to be passes with every API request. This library will automatically include the bearer authentication header for all API calls once you've initialized the instance variable.
var Dotloop = require('dotloop');
var api = new Dotloop('your auth token');
All of the methods below will work with either a standard Javascipt callback function (error, response) or promises. This module uses the Bluebird promise library.
Get all profiles associated with user
Sample Response
[
{
"profileId": 294625,
"name": "Profile 1",
"userId": 0,
"active": true,
"deleted": false,
"profileType": "INDIVIDUAL"
},
{
"profileId": 294626,
"name": "Profile 2",
"userId": 0,
"active": true,
"deleted": false,
"profileType": "OFFICE"
}
]
Returns a list of up to 50 summaries for loops in a profile. To get the next 50 increment the batch number.
Available Options
| Name | Description |
|---|---|
| batchNumber | Increment the batch number to page through results. The default is 1. |
| batchSize | Number of records to return. The maximum value and default value is 50 |
| statusIds | filter loops by status id |
| complianceStatusIds | filter loops by compliance status id |
| tagIds | filter loops by tag id |
| sortBy | |
| searchQuery | |
| tagNames | |
| createdByMe |
Sample Response
[
{
"loopName": "Atturo Garay 123 Main Street, Chicago, IL 60605",
"loopId": 34242,
"loopStatus": "Archived",
"loopTags": [
{
"tagId": 2,
"tagName": "Buying",
"profileId": 4533
}
],
"createdBy": 2097622,
"lastUpdated": "2013-12-03T11:38:22-05:00",
"loopViewId": 76046
},
{
"loopName": "Atturo Garay 3059 main, chicago, IL 60614",
"loopId": 34308,
"loopStatus": "Archived",
"loopTags": [
{
"tagId": 2,
"tagName": "Buying",
"profileId": 69020
}
],
"createdBy": 2097622,
"lastUpdated": "2013-12-03T11:46:16-05:00",
"loopViewId": 80269
}
]
Details of loop view.
Sample Response
[
{
"loopName": "buyers",
"loopId": 274231,
"loopStatus": "Private",
"loopTags": [],
"createdBy": 2571509,
"lastUpdated": "2014-07-28T16:11:56-04:00",
"loopViewId": 404271
}
]
Retrieve the loop details for a single loop. Empty fields are not included in the details. Callers should not expect specific properties to always be included.
Sample Response
{
"loopId": 15751,
"sections": {
"Listing Brokerage": {
"postalCode": "45242",
"name": "DotLoop Final Review",
"stateOrProvince": "OH",
"streetName": "Lake Forest Dr.",
"streetNumber": "4445",
"officePhone": "",
"city": "Cincinnati"
},
"Buying Brokerage": {
"postalCode": "90210",
"name": "Bob's Buying Brokerage",
"stateOrProvince": "CA",
"streetName": "Mockingbird Ln",
"streetNumber": "1313",
"suite": "#1",
"city": "LA"
},
"Property Address": {
"mlsNumber": "1234567890",
"propertyAddressCountry": "USA",
"postalCode": "32123",
"stateOrProvince": "KS",
"streetName": "manor ",
"streetNumber": "1234",
"country": "USA",
"city": "lauderdale"
},
"Financials": {
"comissionRate": "7%",
"earnestMoneyHeldBy": "Steve",
"originalListingPrice": "500,000",
"currentPrice": "425000",
"purchasePrice": "400,000"
}
}
}
Retrieves the activity log for a single loop.
Available Options
| Name | Description |
|---|---|
| batchNumber | Increment the batch number to page through results. The default is 1. |
| batchSize | Number of records to return. The maximum value and default value is 50 |
Sample Response
[
{
"message": "K Fouts (Admin for DotLoop Final Review) viewed document <activity action=\"contracteditor\" viewId=\"15751\" documentId=\"129497\">Agency Disclosure Statement Seller<\/activity>",
"activityDate": "2014-01-09T13:10:14-05:00"
},
{
"message": "K Fouts (Admin for DotLoop Final Review) viewed document <activity action=\"contracteditor\" viewId=\"15751\" documentId=\"129493\">ThaiCatering<\/activity>",
"activityDate": "2014-01-09T13:10:140-5:00"
},
{
"message": "K Fouts (Admin for DotLoop Final Review) viewed document <activity action=\"contracteditor\" viewId=\"15751\" documentId=\"129493\">ThaiCatering<\/activity>",
"activityDate": "2014-01-09T13:08:390-5:00"
},
{
"message": "K Fouts (Admin for DotLoop Final Review) viewed document <activity action=\"contracteditor\" viewId=\"15751\" documentId=\"129497\">Agency Disclosure Statement Seller<\/activity>",
"activityDate": "2014-01-09T13:08:27-05:00"
},
{
"message": "K Fouts (Admin for DotLoop Final Review) viewed document <activity action=\"contracteditor\" viewId=\"15751\" documentId=\"129497\">Agency Disclosure Statement Seller<\/activity>",
"activityDate": "2014-01-09T13:07:43-05:00"
},
{
"message": "K Fouts (Admin for DotLoop Final Review) viewed document <activity action=\"contracteditor\" viewId=\"15751\" documentId=\"129493\">ThaiCatering<\/activity>",
"activityDate": "2014-01-09T13:07:43-05:00"
},
{
"message": "K Fouts (Admin for DotLoop Final Review) viewed document <activity action=\"contracteditor\" viewId=\"15751\" documentId=\"129497\">Agency Disclosure Statement Seller<\/activity>",
"activityDate": "2014-01-09T13:07:08-05:00"
}
]
Retrieve a list of documents within a loop
Sample Response
[
{
"loopId": 405260,
"folderName": "Folder",
"documentId": 561622,
"documentName": "Agency Disclosure Statement Seller",
"signatureVerficationLink": "DL5616224301S",
"lastModifiedDate": "2014-08-25T18:33:46-04:00",
"createdDate": "2014-08-25T23:29:31-04:00",
"sharedWith": [
"405246",
"405247",
"405260"
],
"createdBy": 2462
},
{
"loopId": 405260,
"folderName": "Folder",
"documentId": 561621,
"documentName": "sfr3",
"signatureVerficationLink": "DL56162131X3D",
"lastModifiedDate": "2014-08-25T18:26:38-04:00",
"createdDate": "2014-08-25T23:37:47-04:00",
"sharedWith": [
"405246",
"405247",
"405260"
],
"createdBy": 2462
}
]
Returns a PDF for single document. The parameter “documentName” can be any text, it is provided to let the client choose the file name.
Sample Response
No example included. The response will be a Buffer object with content type of application/pdf.
List of participants in a loop
Sample Response
[
{
"name": "New Person",
"email": "new2_person@email.com",
"role": "None",
"participantId": 3600616,
"memberOfMyTeam": "N"
},
{
"name": "DotLoop Final Review",
"role": "Managing Broker",
"memberOfMyTeam": "Y"
},
{
"name": "K Fouts",
"email": "kfouts@email_address.com",
"role": "Listing Agent",
"memberOfMyTeam": "Y"
}
]
List of tasks in a loop
Sample Response
[
{
"name": "Task New",
"dueDateType": "2013-04-16T00:00:00-04:00",
"dueDate": "2013-04-16T00:00:00-04:00",
"createdDate": "2013-04-30T08:32:43-04:00",
"listName": "My Tasks",
"listId": 208,
"createdBy": 3104719,
"lockedStatus": "N",
"completionStatus": "N"
}
]
List of folders in a loop.
Sample Response
[
{
"viewId": 259626,
"folderId": 314074,
"name": "Folder",
"archived": false,
"minimized": false,
"folderEmailName": "7f9e7d88c31e49ccbf38199689a7e0ea",
"lastUpdatedDateISO": "20140527T10:58:2104:00"
}
]
Activities associated with document
Available Options
| Name | Description |
|---|---|
| batchNumber | Increment the batch number to page through results. The default is 1. |
| batchSize | Number of records to return. The maximum value and default value is 50 |
Sample Response
[
{
"message": "Meyyalagan Chandrasekaran (Admin for DotLoop Final Review) viewed document <activity action=\"contracteditor\" viewId=\"404271\" documentId=\"560621\">Buyers Sign here<\/activity>",
"activityDate": "20140819T18:44:5204:00"
},
{
"message": "Mike Kiburz viewed document <activity action=\"contracteditor\" viewId=\"404271\" documentId=\"560621\">Buyers Sign here<\/activity>",
"activityDate": "20140728T16:49:3604:00"
}
]
List of contacts associated with a profile
Available Options
| Name | Description |
|---|---|
| batchNumber | Increment the batch number to page through results. The default is 1. |
| batchSize | Number of records to return. The maximum value and default value is 50 |
Sample Response
[
{
"personId": 3623822,
"firstName": "Test FirstName",
"lastName": "Test LastName",
"email": "FirstLast@test.com"
},
{
"personId": 3603862,
"firstName": "Test Name",
"lastName": "Test Name",
"email": "abc@test.com"
}
]
Get contact details
Sample Response
[
{
"personId": 3603862,
"firstName": "Brian",
"lastName": "Erwin",
"email": "brianerwin@newkyhome.com",
"homephone": "2138936332",
"officephone": "1121213656",
"streetAddress01": "2100 Waterview dr",
"city": "Richardson",
"zipOrPostalCode": "75081",
"fax": "1118655686",
"stateOrProv": "TX"
}
]
List of up to 5000 summarized employees
Available Options
| Name | Description |
|---|---|
| batchNumber | Increment the batch number to page through results. The default is 1. |
| batchSize | Number of records to return. The maximum value and default value is 50 |
| showAdmin | Show only admins |
| showInActive | Show inactive employees |
| includeChild | Include employees from child profiles |
Sample Response
[
{
"memberId": 294132,
"emailAddress": "smurphy@emailaddress.com",
"firstName": "Scott",
"lastName": "Murphy",
"loopsCreated": 4,
"totalLoops": 5,
"status": "ACTIVE",
"isAdmin": "false"
},
{
"memberId": 290767,
"emailAddress": "rmurphy@emailaddress.com",
"firstName": "Rob",
"lastName": "Murphy",
"loopsCreated": 1,
"totalLoops": 1,
"status": "ACTIVE",
"isAdmin": "false"
}
]
List of admins associated with profile
Available Options
| Name | Description |
|---|---|
| batchNumber | Increment the batch number to page through results. The default is 1. |
| batchSize | Number of records to return. The maximum value and default value is 50 |
Sample Response
[
{
"memberId": 2570270,
"emailAddress": "sellingAgent@emailaddress.com",
"firstName": "TestFirstName2",
"lastName": "TestLastName2",
"status": "ENROLLED",
"isAdmin": "true"
},
{
"memberId": 2629538,
"emailAddress": "listingAgent@emailaddress.com",
"firstName": "TestFirstName1",
"lastName": "TestLastName1",
"status": "ACTIVE",
"isAdmin": "true"
}
]
FAQs
Dotloop API client
The npm package dotloop receives a total of 1 weekly downloads. As such, dotloop popularity was classified as not popular.
We found that dotloop demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.