1. Overview
Lofty service API description
1.1. Version information
Version : 1.0
1.2. URI scheme
Host : api.lofty.com
BasePath : /
1.3. Tags
-
Alerts : Operations about alerts
-
Calls : Operations about calls
-
Leads : Operations about leads
-
Members : Operations about team member
-
Notes : Operations about lead notes
-
Tasks : Operations about tasks
-
TeamFeatures: Operations about team features
-
Webhooks: Operations about webhooks
-
LogType : Operations about lead log call,log email,log text
-
Listing : Operations about listing
2. Getting Started
The simple REST API enables developers to quickly integrate their applications.
API services is actively developing to provide more complete functionality.
2.1. Authentication
In order to ensure data security, Lofty has built-in support for OAuth 2.0 which is extremely useful when setting up integrations between third-party applications and Lofty without passwords being required. To obtain an OAuth2.0 access_token please refer to Lofty OAuth 2.0.
You should set access token, and content type to json through the API call service
Header | Value |
---|---|
Content-type |
application/json |
Authorization |
Bearer [access_token] |
Note
|
Rate limiting will be applied on June 15, 2021 for all those not using a vendorKey. If a vendorKey is not implemented before July 15, 2021, API access will not be available. Please complete the application (see link above) to apply for a security key BEFORE July 15, 2021 to ensure your connected services will not be affected. Once rate limiting starts (June 15, 2021), only ten calls per minute are allowed without a valid vendorKey. If the limit is exceeded, an error will be returned. The endpoints can be called again after one minute with the same limit of 10 calls per minute. |
3. Pagination
List methods that return a collection of resources are paginated using offset and limit query parameters.
GET /v1.0/leads?offset=0&limit=10
Response contains "_metadata" section that includes total number of records available and pagination parameters used in the request:
{ "_metadata": { "collection": "leads", "limit": 1, "offset": 0, "total": 1 }, "leads": [ { "lead": { "firstName": "Kunkun", "lastName": "An", ... } } ... ] }
4. Rate Limiting
The returned HTTP headers of any API request show your current rate limit status:
> curl -i -X GET --header 'Accept: application/json' --header 'Content-Type: application/json' --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHQiOjMxNDc2NzM4OTM5NjYsInVzZXJfaWQiOjEwMDAwMDAwNTE0LCJzY29wZSI6IjUiLCJpYXQiOjE1NzA4NzM4OTM5NjZ9.wrnaQhzW7a7p34Y10uOvM36BDYmPcEqBq_Tt6j_1h' 'https://api.lofty.com/v1.0/me' HTTP/1.1 200 Date: Sat, 21 Oct 2017 04:16:29 GMT X-RateLimit-Limit: 20 X-RateLimit-Remaining: 18 X-RateLimit-Reset: 23000
Header Name | Description |
---|---|
X-RateLimit-Limit |
The maximum number of requests you have allowed in the limited time. |
X-RateLimit-Remaining |
The number of requests remaining in the current rate limit window. |
X-RateLimit-Reset |
The time at which the current rate limit window resets in UTC epoch seconds. |
If you exceed the rate limit, an error response returns:
HTTP/1.1 429 Date: Sat, 21 Oct 2017 07:52:24 GMT Status: 429 Too Many Requests X-RateLimit-Limit: 20 X-RateLimit-Remaining: 0 X-RateLimit-Reset: 21000 {"message":"Too Many Requests"}
5. Resources
5.1. Agent User
Operations about agent user
5.1.1. Create a new agent with profile message
POST /v1.0/agent/profile/add
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
agentProfile |
agentProfile |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
/
5.2. Calls
Operations about calls
5.2.1. Search for calls
GET /v1.0/calls
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
leadId |
Finds calls related to a lead ID |
integer(int64) |
|
Query |
limit |
Number of results to return |
integer(int32) |
|
Query |
offset |
Specifies the number of rows to skip, before starting to return results |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.2.2. Retrieve a call by Id
GET /v1.0/calls/{callId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
callId |
The ID of the call |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.3. Communication
Communication Controller
5.3.1. Search for communication by agent
POST /v1.0/agent/communication
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
communicationRequest |
communicationRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.3.2. Search for call history
GET /v1.0/communication/call
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
currentId |
This parameter is used for page turning. When searching by ID is invoked, the interface would starts from this ID, and retrieve data sequentially. It is recommended to use this parameter as a replacement for offset to turn the page within the limit. |
integer(int64) |
|
Query |
leadId |
ID of Lead |
integer(int64) |
|
Query |
limit |
limit default Value 10, max value 1000 |
integer(int32) |
|
Query |
offset |
offset default Value 0 |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< CallResponse > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.3.3. Search for call history v2
GET /v1.0/communication/call/v2
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
currentId |
This parameter is used for page turning. When searching by ID is invoked, the interface would starts from this ID, and retrieve data sequentially. It is recommended to use this parameter as a replacement for offset to turn the page within the limit. |
integer(int64) |
|
Query |
leadId |
ID of Lead |
integer(int64) |
|
Query |
limit |
limit default Value 10, max value 1000 |
integer(int32) |
|
Query |
offset |
offset default Value 0 |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< CallHistory > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.3.4. Search for email history
GET /v1.0/communication/email
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
currentId |
This parameter is used for page turning. When searching by ID is invoked, the interface would starts from this ID, and retrieve data sequentially. It is recommended to use this parameter as a replacement for offset to turn the page within the limit. |
integer(int64) |
|
Query |
leadId |
ID of Lead |
integer(int64) |
|
Query |
limit |
limit default Value 10, max value 1000 |
integer(int32) |
|
Query |
offset |
offset default Value 0 |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< EmailResponse > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.3.5. Search for text history
GET /v1.0/communication/text
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
currentId |
This parameter is used for page turning. When searching by ID is invoked, the interface would starts from this ID, and retrieve data sequentially. It is recommended to use this parameter as a replacement for offset to turn the page within the limit. |
integer(int64) |
|
Query |
leadId |
ID of Lead |
integer(int64) |
|
Query |
limit |
limit default Value 10, max value 1000 |
integer(int32) |
|
Query |
offset |
offset default Value 0 |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< TextResponse > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.4. LeadRouting
Operations about lead routing
5.4.1. Get Assign Member List
GET /v1.0/routing/member/list/{type}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
type |
Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4) |
integer(int32) |
|
Query |
roleId |
roleId |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.4.2. Get Assign Role List
GET /v1.0/routing/role/list
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.4.3. Get Routing List
GET /v1.0/routing/rule/list/{type}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
type |
Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4) |
integer(int32) |
|
Query |
roleId |
Role id, This parameter is required when type == 4 |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.4.4. Get default rule
GET /v1.0/routing/rule/supplement/{type}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
type |
Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4) |
integer(int32) |
|
Query |
roleId |
Role id, This parameter is required when type == 4 |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.4.5. Edit default routing rule
PUT /v1.0/routing/rule/supplement/{type}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
type |
Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4) |
integer(int32) |
Body |
supplementRoutingRule |
Supplement rule info that needs to be updatedstore |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.4.6. Edit routing rule
PUT /v1.0/routing/rule/{type}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
type |
Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4) |
integer(int32) |
Body |
routingRule |
Lead info that needs to be updated |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5. Leads
Operations about leads
5.5.1. Edit a lead from brokermint
PUT /v1.0/brokermint/lead
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
contacts |
Lead info that needs to be updated |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.2. Update a transaction from brokermint
PUT /v1.0/brokermint/transaction
Description
Update a transaction from brokermint for a lead.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
incomingTransaction |
Lead transaction that needs to be placed |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.3. Create a new lead
POST /v1.0/leads
Description
Lead routing will not be applied unless the leadRouting flag is set to true
Seller(1) Type Lead routing is controlled by LeadRequest.property schema
If the given leadType is not Seller, the lead routing is determined by array LeadRequest.inquiry.locations[]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
hideVendorId |
hideVendorId |
integer(int64) |
Body |
lead |
Lead info that needs to be added in |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.4. Search for leads
GET /v1.0/leads
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
allTags |
Search for lead with all tag names. |
< string > array(multi) |
|
Query |
anyTags |
Search for lead with any tag names. |
< string > array(multi) |
|
Query |
assignedUserId |
Search for contacts by user that is assigned to them. |
integer(int64) |
|
Query |
contacted |
Search for contacts by if they have or have not been contacted. |
boolean |
|
Query |
desc |
Descending sort(true) or ascending sort(false) |
boolean |
|
Query |
email |
Precise search for lead by email address. |
string |
|
Query |
groupIds |
Search for lead by office ids. |
< integer(int64) > array(multi) |
|
Query |
groups |
Search for lead by group names. deprecated, use segments instead. |
< string > array(multi) |
|
Query |
languages |
Search for lead with any languages(abbreviation) |
< string > array(multi) |
|
Query |
limit |
Quantitative limitation of responded leads, range: [1, 100] |
integer(int32) |
|
Query |
offset |
Start index of the responded leads |
integer(int32) |
|
Query |
phone |
Precise search for lead by phone number. |
string |
|
Query |
preciseSearchFlag |
Whether to precise search for leads based on email or phone |
boolean |
|
Query |
querySubGroup |
query sub group leads or not |
boolean |
|
Query |
scrollId |
Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request. |
string |
|
Query |
segments |
Search for lead by segment names. |
< string > array(multi) |
|
Query |
sort |
The sort order can be one of the following: Default, LastContact, LastCall, LastEmail, LastActivity, CreateTime, Inquries, DeleteTime, AssignTime, Score, Activity, Communication, HasDrip, HasAlert, Task, Lender, ActivitySearch, ActivityViews, ActivityFavorites, DripStatus, DripOpenRate, AlertFrequency, AlertOpenRate, SCOREV2 or SmartPlanStatus |
string |
|
Query |
source |
Search for lead by source name. |
string |
|
Query |
stage |
Search for lead by pipeline stage names. |
< string > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.5.5. Search for assignee by lead info
POST /v1.0/leads/assignee
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
leadAssigneeRequest |
Lead info that needs to be searched |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< LeadCustomRoleAssigneeInfo > array |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.6. Search for leads by create time
GET /v1.0/leads/createTime
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
allTags |
Search for lead with all tag names. |
< string > array(multi) |
|
Query |
anyTags |
Search for lead with any tag names. |
< string > array(multi) |
|
Query |
contacted |
Search for contacts by if they have or have not been contacted. |
boolean |
|
Query |
email |
Precise search for lead by email address. |
string |
|
Query |
groups |
Search for lead by group names. deprecated, use segments instead. |
< string > array(multi) |
|
Query |
leadCreateTime |
Minimum create time of the responded leads, parsed according to time zone set as UCT-7 |
string |
|
Query |
limit |
Quantitative limitation of the responded leads, range: [1, 100] |
integer(int32) |
|
Query |
offset |
Start index of the responded leads |
integer(int32) |
|
Query |
phone |
Precise search for lead by phone number. |
string |
|
Query |
scrollId |
Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request. |
string |
|
Query |
segments |
Search for lead by group names. |
< string > array(multi) |
|
Query |
source |
Search for lead by source name. |
string |
|
Query |
stage |
Search for lead by stage names. |
< string > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.5.7. Retrieve the specified URL with a login token
POST /v1.0/leads/specified-url
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
linkRequest |
linkRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.8. Search for leads by update time
GET /v1.0/leads/updateTime
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
allTags |
Search for lead with all tag names. |
< string > array(multi) |
|
Query |
anyTags |
Search for lead with any tag names. |
< string > array(multi) |
|
Query |
contacted |
Search for contacts by if they have or have not been contacted. |
boolean |
|
Query |
email |
Precise search for lead by email address. |
string |
|
Query |
groups |
Search for lead by group names. |
< string > array(multi) |
|
Query |
leadUpdateTime |
Minimum update time of the responded leads, parsed according to time zone set as UCT-7 |
string |
|
Query |
limit |
Quantitative limitation of the responded leads, range: [1, 100] |
integer(int32) |
|
Query |
offset |
Start index of the responded leads |
integer(int32) |
|
Query |
phone |
Precise search for lead by phone number. |
string |
|
Query |
scrollId |
Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request. |
string |
|
Query |
segments |
Search for lead by group names. |
< string > array(multi) |
|
Query |
source |
Search for lead by source name. |
string |
|
Query |
stage |
Search for lead by stage names. |
< string > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.5.9. Retrieve a lead by Id
GET /v1.0/leads/{leadId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
leadId |
The ID of the lead to get. |
integer(int64) |
|
Query |
withTrash |
Whether to query deleted lead. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.5.10. Edit a lead
PUT /v1.0/leads/{leadId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
The ID of the lead to update. |
integer(int64) |
Body |
request |
Lead info that needs to be updated |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.11. Delete a lead
DELETE /v1.0/leads/{leadId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
The ID of the lead to trash. |
integer(int64) |
Query |
reason |
The reason to trash this lead |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
Produces
-
application/json
5.5.12. Search for activities
GET /v1.0/leads/{leadId}/activities
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
|
Query |
curPage |
The page number of the returning data. One page has 100 data. Default value is 0. |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< LeadActivityRes > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.5.13. Add activity
POST /v1.0/leads/{leadId}/activity
Description
Add activity to a lead.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Body |
leadActivity |
Lead activity |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.14. Assign a lead
POST /v1.0/leads/{leadId}/assignment
Description
Place assignee to a lead.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Body |
assigneeRequest |
Lead assignees |
< LeadAssigineeRequest > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.15. Place an inquiry
POST /v1.0/leads/{leadId}/inquiry
Description
Place an inquiry for a lead.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Body |
inquiry |
Lead inquiry that needs to be placed |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.16. Place a property
POST /v1.0/leads/{leadId}/property
Description
Place a property for a lead.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Body |
property |
Lead property that needs to be placed |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.17. Add a transaction
POST /v1.0/leads/{leadId}/transaction
Description
Add a transaction for a lead.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Body |
leadTransaction |
Lead transaction that needs to be placed |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.18. Update address of transaction’s property
POST /v1.0/leads/{leadId}/transaction/property/address
Description
Update address of transaction’s property for a lead.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Body |
address |
Address of lead transaction’s property that needs to be placed |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.19. query transaction by leadId AND transactionId
GET /v1.0/leads/{leadId}/transaction/{transactionId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Path |
transactionId |
transactionId |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.5.20. Update a transaction
PUT /v1.0/leads/{leadId}/transaction/{transactionId}
Description
Update a transaction for a lead.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Path |
transactionId |
transactionId |
integer(int64) |
Body |
leadTransaction |
Lead transaction that needs to be placed |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.5.21. Query address of transaction’s property by transactionId
GET /v1.0/leads/{leadId}/transaction/{transactionId}/property/address
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Path |
transactionId |
transactionId |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.5.22. query transactions by leadId
GET /v1.0/leads/{leadId}/transactions
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
leadId |
leadId |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< LeadTransaction > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.5.23. query transaction all custom fields
GET /v1.0/transaction/customfields
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< CustomFieldResponse > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.6. Members
Operations about team member
5.6.1. Get current user’s info
GET /v1.0/me
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.6.2. Get team members
GET /v1.0/members
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
groupIds |
Group Ids of responded members |
< integer(int64) > array(multi) |
|
Query |
limit |
Quantitative limitation of responded members |
integer(int32) |
|
Query |
offset |
Start index of the responded members |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.6.3. Get member by account
GET /v1.0/members/{account}
Description
Get team member by member account.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
account |
The account (email) of the team member to get |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
/
5.6.4. Get user by Id
GET /v1.0/users/{userId}
Caution
|
operation.deprecated |
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userId |
The ID of the user to get |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.6.5. Edit a user
PUT /v1.0/users/{userId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userId |
userId |
integer(int64) |
Body |
userRequest |
user info that needs to be updated |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.7. Notes
Operations about lead notes
5.7.1. Add a note
POST /v1.0/notes
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
leadNote |
LeadNote info that needs to be added in |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.7.2. Search for notes
GET /v1.0/notes
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
includeSystemNote |
Include System note or not |
boolean |
|
Query |
leadId |
ID of Lead |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< NoteResponse > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.7.3. Get note by Id
GET /v1.0/notes/{noteId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
noteId |
ID of Note |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.7.4. Edit a note
PUT /v1.0/notes/{noteId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
noteId |
The ID of the note to update |
integer(int64) |
Body |
leadNote |
LeadNote info that needs to be updatedstore |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json;charset=UTF-8
5.7.5. Delete a note
DELETE /v1.0/notes/{noteId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
noteId |
The ID of the note to delete |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
Produces
-
application/json;charset=UTF-8
5.8. Tasks & Appointments
Operations about tasks and appointments
5.8.1. Get appointments of lead
GET /v1.0/appts
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
leadId |
Lead id |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.8.2. Add a new task
POST /v1.0/tasks
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
leadTask |
LeadTask info that needs to be added in |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.8.3. Get tasks of lead
GET /v1.0/tasks
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
leadId |
The ID of the lead to get tasks |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.8.4. Get task by Id
GET /v1.0/tasks/{taskId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
taskId |
The ID of the task to get |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.8.5. Update a new task
PUT /v1.0/tasks/{taskId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
taskId |
The ID of the Task to update |
integer(int64) |
Body |
leadTask |
LeadTask info that needs to be updated |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.8.6. Delete a task
DELETE /v1.0/tasks/{taskId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
taskId |
The ID of the Task to delete |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
Produces
-
application/json
5.9. TeamFeatures
Operations about team feature
5.9.1. Search lead pond
GET /v1.0/team-features/lead-pond/{id}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
id |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.9.2. list lead pond
GET /v1.0/team-features/lead-ponds
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< LeadPond > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.9.3. add new custom field
POST /v1.0/teamFeatures/custom-field
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
customAttribute |
customAttribute |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.9.4. Search custom field
GET /v1.0/teamFeatures/listCustomField
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< CustomAttribute > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.9.5. Search existing tag
GET /v1.0/teamFeatures/listTag
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< UserLeadTag > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.10. User Account
Operations about user account
5.10.1. Create an new account
POST /v1.0/agent
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
accountRequest |
account info that needs to be created |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.10.2. Edit an account
PUT /v1.0/agent
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
accountRequest |
account info that needs to be edited |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.11. Vendor
Vendor Controller
5.11.1. query vendor info
GET /v1.0/vendor/list
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< VendorInfo > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.11.2. get oauth token info by old apikey
GET /v1.0/vendor/oauth/token-info/byold
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.12. Webhooks
Use webhooks to be notified about events that happen in a lofty account
supported webhook events:
1, Agent List
List id: 1
Scope: UserResponse
2, Lead Information
List id: 2
Scope: LeadResponse
3, Lead Activity
List id: 3
Scope: LeadActivity 4, Listing Alert
List id: 4
Scope: Alert
5.12.1. add a new webhook
POST /v1.0/webhook
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
webhookRequest |
webhook info that needs to be added in |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.12.2. Delete a webhook
DELETE /v1.0/webhook/{subscribeId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
subscribeId |
The subscribeId of the webhook to delete |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
Produces
-
application/json
5.12.3. get all webhook from current team
GET /v1.0/webhooks
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.13. Agent Organization
Operations agent organization
5.13.1. Get User Organization
GET /v1.0/org
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.13.2. Edit Agent Company
POST /v1.0/org/company
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
vo |
vo |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.13.3. Update Agent Office
POST /v1.0/org/office
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
vo |
vo |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.13.4. Add Agent Office
PUT /v1.0/org/office
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
vo |
vo |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.13.5. Get Permission Profiles
GET /v1.0/org/permission/profiles
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< PermissionProfile > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.14. Broker
Operations about broker team
5.14.1. Create team under the broker account
POST /v1.0/broker/team
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
brokerTeam |
brokerTeam |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.14.2. Remove team from the broker account
DELETE /v1.0/broker/team/{id}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
id |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
Produces
-
application/json
5.15. Listing
Listing data Controller
5.15.1. Get published listings
GET /v1.0/getPublishedListings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
type |
LuxVT|AptCom|AllOnMarket |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/xml
5.15.2. getByUserId
GET /v1.0/listing
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
agentListings |
agentListings |
boolean |
|
Query |
buildingAddress |
buildingAddress |
string |
|
Query |
buildingName |
buildingName |
string |
|
Query |
limit |
limit |
integer(int32) |
|
Query |
listingId |
listingId |
string |
|
Query |
mlsListingIds |
mlsListingIds |
string |
|
Query |
nextPageKey |
nextPageKey |
string |
|
Query |
officeListings |
officeListings |
boolean |
|
Query |
showCondition |
showCondition |
boolean |
|
Query |
soldListingId |
soldListingId |
string |
|
Query |
street |
street |
string |
|
Query |
userId |
userId |
integer(int64) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.16. LogType
Operations about lead log call/log email/log text
5.16.1. Add a log call/email/text
POST /v1.0/logType
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
request |
logType info that needs to be added in |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.16.2. Search for log call/email/text
GET /v1.0/logType
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
currentId |
This parameter is used for page turning. When searching by ID is invoked, the interface would starts from this ID, and retrieve data sequentially. It is recommended to use this parameter as a replacement for offset to turn the page within the limit. |
integer(int64) |
|
Query |
leadId |
ID of Lead |
integer(int64) |
|
Query |
limit |
limit default Value 10, max value 1000 |
integer(int32) |
|
Query |
logType |
query type value: logCall,logEmail,logText |
string |
|
Query |
offset |
offset default Value 0 |
integer(int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< LogTypeResponse > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.16.3. Get log call/email/text by Id
GET /v1.0/logType/{logTypeId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
logTypeId |
ID of Log type |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
5.16.4. Delete a log type
DELETE /v1.0/logType/{logTypeId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
logTypeId |
The ID of the log type to delete |
integer(int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
Produces
-
application/json;charset=UTF-8
5.17. Opportunity
Operations about opportunity
5.17.1. sendOpportunityNotification
POST /v1.0/agent/send-notification
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
opportunityNotificationRequest |
opportunityNotificationRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
5.18. System Logs
query lead system logs
5.18.1. Search for system logs
GET /v1.0/systemLogs
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
endTime |
the timestamp of end |
integer(int64) |
|
Query |
leadId |
ID of Lead |
integer(int64) |
|
Query |
pageNumber |
page number, fist is 0 |
integer(int32) |
|
Query |
pageSize |
ID of Lead |
integer(int32) |
|
Query |
startTime |
the timestamp of start |
integer(int64) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< SystemLogResponse > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/json
6. Definitions
6.1. AccountInfo
Name | Description | Schema |
---|---|---|
allowChangeDomain |
boolean |
|
domain |
string |
|
emailAddress |
email address of the agent |
string |
firstName |
first name of the agent |
string |
groupId |
integer(int64) |
|
headUrl |
The head url of the agent |
string |
lastName |
last name of the agent |
string |
permissions |
< string > array |
|
phoneCode |
phone code of the agent |
string |
phoneCountry |
phone country of the agent |
string |
phoneNumber |
phone number of the agent |
string |
roleId |
integer(int64) |
|
sendingEmail |
string |
|
tagIds |
tags of the agent |
< integer(int64) > array |
6.2. AccountRequest
Name | Description | Schema |
---|---|---|
address |
address of the agent |
string |
allowChangeSendingEmailAddress |
Allow this individual to change their own sending email domain |
boolean |
emailAddress |
The email of the agent |
string |
firstName |
The first name of the agent |
string |
groupId |
Group Id. |
integer(int64) |
lastName |
The last name of the agent |
string |
licenseId |
licenseId of the agent |
string |
permissions |
Account’s permissions. |
< string > array |
personalWebsite |
Personal Website |
string |
phone |
The phone number of the agent |
string |
position |
position |
string |
profileId |
Permission Profile Id. |
integer(int64) |
selfIntroduction |
Self Introduction |
string |
sendingEmailAddress |
Sending Email Address Domain |
string |
socialMedias |
Social media of agent, include company info |
|
teamMemberUserId |
the id of the agent |
integer(int64) |
6.3. AccountResponse
Name | Description | Schema |
---|---|---|
agentId |
The id of the agent |
integer(int64) |
allowChangeSendingEmailAddress |
Allow this individual to change their own sending email domain |
boolean |
emailAddress |
The email of the agent |
string |
firstName |
The first name of the agent |
string |
groupId |
Group Id |
integer(int64) |
lastName |
The last name of the agent |
string |
permissions |
Account’s permissions |
< string > array |
phone |
The phone number of the agent |
string |
profileId |
Permission Profile Id |
integer(int64) |
seatType |
integer(int32) |
|
sendingEmailAddress |
Sending Email Address Domain |
string |
teamId |
The teamId of the agent’s team |
integer(int64) |
6.4. ActiveHours
Name | Description | Schema |
---|---|---|
activeDays |
Active day list, between 1 and 7 |
< integer(int32) > array |
hoursEnd |
Active hours end, between 0 and 23 |
integer(int32) |
hoursStart |
Active hours start, between 0 and 23 |
integer(int32) |
6.5. AgentInfo
Name | Description | Schema |
---|---|---|
agentPid |
Agent Pid |
string |
companyAddress |
Agent company Address |
string |
companyName |
Agent Company Name |
string |
licenseId |
Agent license Id |
string |
mlsAgentId |
MLS Agent Id |
string |
position |
Agent position |
string |
6.6. AgentProfile
Name | Description | Schema |
---|---|---|
accountInfo |
Account Base Info of agent, like name , email or phone and something else |
|
accountType |
The account type of the agent |
integer(int32) |
agentPid |
string |
|
checkRosterNum |
boolean |
|
fullSync |
boolean |
|
hasBackOffice |
boolean |
|
personalPhotos |
Personal photos of agent |
|
shouldSync |
boolean |
|
socialMedias |
Social media of agent, include company info |
|
workInfo |
Work Info of agent, include company info etc.. |
6.7. Appointment
Name | Description | Schema |
---|---|---|
address |
The location of the appointment |
string |
allDay |
Whether the appointment time is all day |
boolean |
assignRoleType |
The user role of the appointment assigned to |
integer(int32) |
assignToUid |
The user’s Id of the appointment assigned to |
integer(int64) |
createTime |
The create time of the appointment |
string(date-time) |
creatorId |
The user ID of this appointment creator |
integer(int64) |
deadline |
The start time of the appointment |
integer(int64) |
deleteFlag |
If the appointment is deleted or not |
boolean |
descr |
The description of the appointment |
string |
endTime |
The end time of the appointment |
integer(int64) |
finishFlag |
If the appointment is finished or not |
boolean |
finishTime |
The finish time of the task |
integer(int64) |
id |
The Id of the appointment |
integer(int64) |
lastUpdate |
The last update time of the appointment |
string(date-time) |
leadId |
The lead(Id) associated with the appointment |
integer(int64) |
overdue |
If the appointment is overdue or not |
boolean |
6.8. AssignMember
Name | Description | Schema |
---|---|---|
id |
Member id |
integer(int64) |
name |
Member name |
string |
type |
Member type |
integer(int32) |
6.9. AssignRole
Name | Description | Schema |
---|---|---|
id |
Role id |
integer(int64) |
name |
Role name |
string |
6.10. BrokerTeam
Name | Description | Schema |
---|---|---|
email |
Team admin email |
string |
firstName |
Team admin first name |
string |
lastName |
Team admin last name |
string |
phone |
Team admin phone |
string |
seatLimit |
Team seat limit |
integer(int32) |
teamName |
Team Name |
string |
6.11. CallHistory
Name | Description | Schema |
---|---|---|
agentId |
The Id of the agent |
integer(int64) |
createTime |
The createTime of the call |
string |
direction |
Outbound or Inbound call |
string |
id |
The Id of the call |
integer(int64) |
leadId |
The lead(Id) associated with the call |
integer(int64) |
leadPhoneNumber |
The phone number of the lead |
string |
6.12. CallListResponse
Name | Schema |
---|---|
_metadata |
|
calls |
< CallResponse > array |
6.13. CallResponse
Name | Description | Schema |
---|---|---|
agentId |
The related Agent ID |
integer(int64) |
callingOutcome |
The outcome of the call |
string |
createTime |
The createTime of the call |
string |
dialerCallRecordId |
The Id of the call record |
integer(int64) |
direction |
Outbound or Inbound call |
string |
duration |
The duration of the call |
integer(int32) |
elapsedTime |
The connection time of the call |
string |
endTime |
The end time of the call |
string |
id |
The Id of the call |
integer(int64) |
isMachineAnswered |
If the call is answered by machine |
boolean |
leadId |
The lead(Id) associated with the call |
integer(int64) |
leadPhoneNumber |
The phone number of the lead |
string |
note |
The note of the call |
string |
price |
The price of the call |
number(double) |
rateScore |
The rateScore of the call |
integer(int32) |
recordingSwitch |
If record this call or not |
boolean |
showUserNumber |
The phone number showed for the lead who received this call |
string |
startTime |
The start time of the call |
string |
status |
The status of the call |
string |
updateTime |
The updateTime of the call |
string |
userId |
The Id of the user |
integer(int64) |
userPhoneNumber |
The phone number of the user |
string |
6.14. Commission
Name | Description | Schema |
---|---|---|
calculateType |
AMOUNT. default AMOUNT |
enum (AMOUNT, PERCENT) |
desc |
no more than 512 chars |
string |
id |
integer(int64) |
|
payTo |
agentId, teamId or leadId |
integer(int64) |
payToName |
no more than 255 chars |
string |
payType |
TEAM, AGENT, VENDOR_PARTNER, LEAD, OTHER. default AGENT |
enum (AGENT, BROKERAGE, LEAD, OTHER, TEAM, VENDOR_PARTNER) |
splitPayTo |
agentId, teamId or leadId |
integer(int64) |
splitPayToName |
no more than 255 chars |
string |
splitPayType |
enum: TEAM, AGENT, VENDOR_PARTNER, LEAD, OTHER, BROKERAGE. default AGENT |
enum (AGENT, BROKERAGE, LEAD, OTHER, TEAM, VENDOR_PARTNER) |
value |
pay amount in cents or percentage(for example,5023, 8010) value differentiated by calculateType. If less than 0 then Deduct else Add as for Pre-Split and Post-Split |
integer(int64) |
6.15. Commissions
Name | Description | Schema |
---|---|---|
postSplit |
Post Split Commissions |
< Commission > array |
preSplit |
Pre Split Commissions |
< Commission > array |
split |
Split Commissions |
< Commission > array |
6.16. CommunicationRequest
Name | Description | Schema |
---|---|---|
endTime |
endTimestamp (The maximum time interval for a single query is 24 hours) |
integer(int64) |
limit |
limit default Value 10,max value 1000 |
integer(int32) |
offset |
offset default Value 0 |
integer(int32) |
startTime |
startTimestamp |
integer(int64) |
teamView |
search team lead’s communication, default false |
boolean |
type |
CALL, EMAIL OR TEXT |
enum (CALL, EMAIL, TEXT) |
6.17. CommunicationResponse
Name | Description | Schema |
---|---|---|
agentId |
The related Agent ID |
integer(int64) |
callDuration |
Dialer call duration |
string |
callOutcome |
Dialer call outcome |
string |
communicationTime |
The time of the communication |
string |
communicationType |
The communication type (AUTO, MANUAL OR LOGGED) |
string |
direction |
Outbound or Inbound |
string |
eventType |
The event type (Call, Text, Opened Email, Bounced Email or Sent Email) |
string |
fromPond |
Is the communication from the lead pond |
boolean |
id |
The ID of the communication |
integer(int64) |
leadId |
The lead(Id) associated with the communication |
integer(int64) |
status |
The communication status |
string |
6.18. CompanyOpenVo
Name | Schema |
---|---|
city |
string |
email |
string |
header |
string |
name |
string |
phone |
string |
phoneCode |
string |
phoneCountry |
string |
state |
string |
streetAddress |
string |
teamId |
integer(int64) |
zipcode |
string |
6.19. Contacts
Name | Schema |
---|---|
address |
string |
bmPrivate |
boolean |
city |
string |
contactType |
string |
email |
string |
externalId |
string |
firstName |
string |
lastName |
string |
leadSource |
string |
phone |
string |
state |
string |
zip |
string |
6.20. CustomAttribute
Name | Description | Schema |
---|---|---|
attributeName |
The name of this custom field |
string |
attributeType |
The type of the field |
string |
params |
options for select, such as {"option":["item1","item2",…]} |
string |
value |
The content of the field for lead, value for multi-select,such as "["item1","item2\s",…]" .It’s unnecessary when adding a new custom field for team |
string |
6.21. CustomFieldRequest
Name | Description | Schema |
---|---|---|
id |
Custom field id |
integer(int64) |
value |
Custom field value For multi_select, the format is:["Item1","Item2", …] |
string |
6.22. CustomFieldResponse
Name | Description | Schema |
---|---|---|
id |
Custom field id |
integer(int64) |
name |
Custom field name |
string |
params |
Custom field drop-down params |
string |
type |
Custom field type |
string |
6.23. CustomRole
Name | Description | Schema |
---|---|---|
assignee |
The user account of this custom role |
string |
assigneeId |
The user id of this custom role |
integer(int64) |
role |
The name of this custom role |
string |
roleId |
The ID of this custom role |
integer(int32) |
6.24. CustomRoleAssignee
Name | Description | Schema |
---|---|---|
agentFullName |
Agent Full Name |
string |
assignee |
The user account of this custom role |
string |
assigneeId |
The user id of this custom role |
integer(int64) |
permissionProfileName |
The permission profile name of this custom role |
string |
role |
The name of this custom role |
string |
roleId |
The ID of this custom role |
integer(int32) |
6.25. EditLeadRequest
Name | Description | Schema |
---|---|---|
assignedUserId |
Id of the agent assigned to this contact |
integer(int64) |
birthday |
The birthday of the lead(pattern:MMM d, yyyy) |
string |
buyHouse |
Buy a house, |
string |
buyingTimeFrame |
buying time frame, |
string |
cannotCall |
false: can call to the lead |
boolean |
cannotEmail |
false: can email to the lead |
boolean |
cannotText |
false: can send message to the lead |
boolean |
city |
The city associated with the lead |
string |
customAttributeList |
User customized field |
< CustomAttribute > array |
emails |
A list of email addresses associated with the lead |
< string > array |
firstName |
The first/given name of the lead |
string |
fthb |
first time home buyer, |
string |
groups |
The groups the lead is in |
< string > array |
houseToSell |
House to Sell, |
string |
inquiry |
The inquiry of the lead |
|
isPrivate |
The lead is private or not |
boolean |
language |
The lead’s abbreviated language, |
string |
lastName |
The last/family name of the lead |
string |
leadFamilyMemberList |
A list of family members associated with the lead. You can add up to 4 family members. |
< LeadFamilyMember > array |
leadTransaction |
||
leadType |
Type of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Buyer & Seller (3), Renter (5) |
integer(int32) |
leadTypes |
Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7),Homeowner (8), Landlord (9) |
< integer(int32) > array |
mortgage |
Mortgage, |
string |
phones |
A list of phone numbers associated with the lead. (No more than 20 characters per phone) |
< string > array |
preQual |
Pre-qual, |
string |
property |
The property of the lead. |
|
referredBy |
The referee of the lead |
string |
segments |
The segments the lead is in |
< string > array |
sellingTimeFrame |
selling time frame, |
string |
source |
The source of the lead |
string |
stage |
The stage the lead is in, less than 20 characters |
string |
state |
The state associated with the lead |
string |
streetAddress |
The streetAddress associated with the lead |
string |
tags |
The tags associated with the lead. All existing tags will be updated based on this call |
< string > array |
tagsAdd |
The tags associated with the lead. All existing tags will be retained, only add new tags base on this call |
< string > array |
unsubscription |
Unsubscription the email |
boolean |
withBuyerAgent |
With buyer Agent, |
string |
withListingAgent |
With listing agent, |
string |
zipCode |
ZipCode |
string |
6.26. EmailResponse
Name | Description | Schema |
---|---|---|
agentId |
The related Agent ID |
integer(int64) |
direction |
Outbound or Inbound email |
string |
emailEventTime |
The event time of the email |
string |
emailSubject |
The subject of the email |
string |
emailType |
Manual or Auto email |
string |
eventType |
Sent, Opened or Bounced event |
string |
fromPond |
Is the email sent from the lead pond |
boolean |
id |
The ID of the email |
integer(int64) |
leadId |
The lead(Id) associated with the email |
integer(int64) |
6.27. EnterpriseInfo
Name | Description | Schema |
---|---|---|
groupId |
Group ID |
integer(int64) |
groupName |
Group Name |
string |
profileId |
Permission Profile ID |
integer(int64) |
profileName |
Permission Profile Name |
string |
visibleOrgInfoList |
Visible Sub Org Info |
< VisibleOrgInfo > array |
6.28. FileInfo
Name | Schema |
---|---|
contentType |
string |
fileName |
string |
queryLink |
string |
size |
integer(int32) |
6.29. IncomingTransaction
Name | Schema |
---|---|
acceptanceDate |
|
address |
string |
agentId |
integer(int64) |
agentName |
string |
city |
string |
closedAt |
|
closingDate |
|
expirationDate |
|
id |
integer(int64) |
price |
number |
representing |
string |
state |
string |
status |
string |
transactionType |
string |
zip |
string |
6.30. Item
Name | Schema |
---|---|
name |
string |
type |
string |
value |
string |
6.31. JsonNode
Type : object
6.32. LeadActivityReq
Name | Description | Schema |
---|---|---|
created |
created time in milliseconds |
integer(int64) |
link |
Url for web page |
string |
listing |
Listing details |
|
pageName |
The page name of the lead’s submission(re-inquiry) page |
string |
picture |
Preview picture url |
string |
scheduledDate |
Scheduled date about this showing request |
string |
text |
Search Text |
string |
type |
Type, |
string |
6.33. LeadActivityRes
Name | Description | Schema |
---|---|---|
created |
created time in milliseconds |
integer(int64) |
link |
Url for web page |
string |
listing |
Listing details |
|
pageName |
The page name of the lead’s submission(re-inquiry) page |
string |
picture |
Preview picture url |
string |
scheduledDate |
Scheduled date about this showing request |
string |
text |
Search Text |
string |
type |
Type, |
string |
6.34. LeadAssigineeRequest
Name | Description | Schema |
---|---|---|
assiginee |
Account of assignee |
string |
role |
Role, |
string |
6.35. LeadAssigneeRequest
Name | Description | Schema |
---|---|---|
birthday |
The birthday of the lead(pattern:MMM d, yyyy) |
string |
email |
The email address associated with the lead |
string |
firstName |
The first name of the lead |
string |
lastName |
The last name of the lead |
string |
phone |
The phone number associated with the lead. (No more than 20 characters per phoneï¼ |
string |
6.36. LeadCustomRoleAssigneeInfo
Name | Description | Schema |
---|---|---|
customRoleAssignees |
lead customRoleAssignees |
< CustomRoleAssignee > array |
firstName |
lead firstName |
string |
lastName |
lead lastName |
string |
leadId |
leadId |
integer(int64) |
leadUserId |
leadUserId |
integer(int64) |
6.37. LeadFamilyMember
Name | Description | Schema |
---|---|---|
birthday |
The birthday of the family member(pattern:MMM d, yyyy) |
string |
emails |
A list of email addresses associated with the lead |
< string > array |
firstName |
The first name of the family member |
string |
lastName |
The last name of the family member |
string |
phones |
A list of phone numbers associated with the family member. (No more than 20 characters per phoneï¼ |
< string > array |
relationship |
The relationship of this family member to primary lead. Example: Husband |
string |
6.38. LeadInquiryReq
Name | Description | Schema |
---|---|---|
bathroomsMax |
string |
|
bathroomsMin |
Bath Rooms |
string |
bedroomsMax |
integer(int32) |
|
bedroomsMin |
Bed Rooms |
integer(int32) |
createTime |
string(date-time) |
|
id |
integer(int64) |
|
leadUserId |
integer(int64) |
|
locations |
Locations |
< Location > array |
modifyByAgent |
boolean |
|
priceMax |
Price range higher end |
integer(int64) |
priceMin |
Price range lower end |
integer(int64) |
propertyType |
Property types: |
< string > array |
updateTime |
string(date-time) |
6.39. LeadInquiryRes
Name | Description | Schema |
---|---|---|
bathroomsMax |
string |
|
bathroomsMin |
Bath Rooms |
string |
bedroomsMax |
integer(int32) |
|
bedroomsMin |
Bed Rooms |
integer(int32) |
createTime |
string(date-time) |
|
defaultValue |
boolean |
|
id |
integer(int64) |
|
leadUserId |
integer(int64) |
|
locations |
Locations |
< Location > array |
modifyByAgent |
boolean |
|
priceMax |
Price range higher end |
integer(int64) |
priceMin |
Price range lower end |
integer(int64) |
propertyType |
Property types: |
< string > array |
updateTime |
string(date-time) |
6.40. LeadListResponse
Name | Schema |
---|---|
_metadata |
|
leads |
< LeadResponse > array |
6.41. LeadPond
Name | Description | Schema |
---|---|---|
agentIds |
The accessible agent id of the lead pond, It’s a list with user ids |
< integer(int64) > array |
id |
The id of this lead pond |
integer(int64) |
pondName |
The name of this lead pond |
string |
pondOwnerId |
The owner user id of the lead pond |
integer(int64) |
6.42. LeadPropertyReq
Name | Description | Schema |
---|---|---|
autoListingId |
integer(int64) |
|
bathrooms |
The bath rooms. |
number(double) |
bedrooms |
The bed rooms. |
integer(int32) |
city |
The city |
string |
county |
The county |
string |
floors |
The floors. |
integer(int32) |
id |
integer(int64) |
|
label |
string |
|
labelList |
string |
|
labelType |
string |
|
leadUserId |
integer(int64) |
|
listingId |
string |
|
listingStatus |
string |
|
lotSize |
The lot size (acreage). |
number(double) |
mailAddress |
Mailing address |
boolean |
note |
string |
|
parkingSpace |
The parking space. |
integer(int64) |
pictureUrl |
string |
|
price |
The price |
integer(int64) |
priceMax |
The max price |
integer(int64) |
priceMin |
The min price |
integer(int64) |
propertyType |
Property type: |
string |
siteListingUrl |
string |
|
squareFeet |
The square feet. |
integer(int64) |
state |
The state |
string |
streetAddress |
The street address |
string |
zipCode |
The zip code |
string |
6.43. LeadPropertyRes
Name | Description | Schema |
---|---|---|
autoListingId |
integer(int64) |
|
bathrooms |
The bath rooms. |
number(double) |
bedrooms |
The bed rooms. |
integer(int32) |
city |
The city |
string |
county |
The county |
string |
floors |
The floors. |
integer(int32) |
id |
integer(int64) |
|
label |
string |
|
labelList |
string |
|
labelType |
string |
|
leadUserId |
integer(int64) |
|
listingId |
string |
|
listingStatus |
string |
|
lotSize |
The lot size (acreage). |
number(double) |
mailAddress |
Mailing address |
boolean |
note |
string |
|
parkingSpace |
The parking space. |
integer(int64) |
pictureUrl |
string |
|
price |
The price |
integer(int64) |
propertyType |
Property type: |
string |
siteListingUrl |
string |
|
squareFeet |
The square feet. |
integer(int64) |
state |
The state |
string |
streetAddress |
The street address |
string |
zipCode |
The zip code |
string |
6.44. LeadRequest
Name | Description | Schema |
---|---|---|
assignGroupId |
Pass the Group id value to specify the routing rule for a certain scope. If set to -1, the lead will be to company routing rule . |
integer(int64) |
assignedUserId |
Id of the agent assigned to this contact |
integer(int64) |
birthday |
The birthday of the lead(pattern:MMM d, yyyy) |
string |
buyHouse |
Buy a house, |
string |
buyingTimeFrame |
buying time frame, |
string |
cannotCall |
false: can call to the lead |
boolean |
cannotEmail |
false: can email to the lead |
boolean |
cannotText |
false: can send message to the lead |
boolean |
city |
The city associated with the lead |
string |
content |
Note content |
string |
customAttributeList |
User customized field |
< CustomAttribute > array |
emails |
A list of email addresses associated with the lead |
< string > array |
firstName |
The first/given name of the lead |
string |
fthb |
first time home buyer, |
string |
groups |
The groups the lead is in |
< string > array |
houseToSell |
House to Sell, |
string |
inquiry |
The inquiry of the lead |
|
isPin |
Pin this note or not |
boolean |
isPrivate |
The lead is private or not |
boolean |
language |
The lead’s abbreviated language, |
string |
lastName |
The last/family name of the lead |
string |
leadAlert |
send new lead alert email. (Not supporting update) |
boolean |
leadFamilyMemberList |
A list of family members associated with the lead. You can add up to 4 family members. |
< LeadFamilyMember > array |
leadRouting |
Assign leads via Lead Routing. |
boolean |
leadTransaction |
||
leadType |
Type of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Buyer & Seller (3), Renter (5) |
integer(int32) |
leadTypes |
Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7), Homeowner (8), Landlord (9) |
< integer(int32) > array |
mortgage |
Mortgage, |
string |
phones |
A list of phone numbers associated with the lead. (No more than 20 characters per phone) |
< string > array |
preQual |
Pre-qual, |
string |
property |
The property of the lead. |
|
referredBy |
The referee of the lead |
string |
segments |
The segments the lead is in |
< string > array |
sellingTimeFrame |
selling time frame, |
string |
source |
The source of the lead |
string |
stage |
The stage the lead is in, less than 20 characters |
string |
state |
The state associated with the lead |
string |
streetAddress |
The streetAddress associated with the lead |
string |
tags |
The tags associated with the lead. All existing tags will be updated based on this call |
< string > array |
tagsAdd |
The tags associated with the lead. All existing tags will be retained, only add new tags base on this call |
< string > array |
unsubscription |
Unsubscription the email |
boolean |
welcomeEmail |
send Welcome Email. (Not supporting update) |
boolean |
withBuyerAgent |
With buyer Agent, |
string |
withListingAgent |
With listing agent, |
string |
zipCode |
ZipCode |
string |
6.45. LeadResponse
Name | Description | Schema |
---|---|---|
assignCompletionStatus |
Whether complete all lead assign process |
boolean |
assignTime |
The assigned time of the lead |
string |
assignedUser |
The Username of the lead assigned to |
string |
assignedUserId |
The user Id of the lead assigned to |
integer(int64) |
birthday |
The birthday of the lead |
string |
buyHouse |
Buy a house, |
string |
buyingTimeFrame |
buying time frame, |
string |
cannotCall |
false: can call to the lead |
boolean |
cannotEmail |
false: can email to the lead |
boolean |
cannotText |
false: can send message to the lead |
boolean |
city |
The city associated with the lead |
string |
createTime |
The create time of the lead |
string |
customAttributes |
User customized field |
< CustomAttribute > array |
customRoleList |
< CustomRole > array |
|
emails |
The email list of the lead |
< string > array |
facebook |
The Facebook account of the lead |
string |
firstName |
The first/given name of the lead |
string |
fthb |
first time home buyer, |
string |
groups |
The groups that the lead in. deprecated, use segments instead. |
< string > array |
houseToSell |
House to Sell, |
string |
language |
The language of the lead |
string |
lastName |
The last/family name of the lead |
string |
lastTouch |
The last touch time of the lead |
string |
lastUpdateTime |
The update time of the lead |
string |
lastVisit |
The last visit time of the lead |
string |
leadFamilyMemberList |
A list of family members associated with the lead |
< LeadFamilyMember > array |
leadId |
The Id of the lead |
integer(int64) |
leadInquiry |
LeadInquirys |
|
leadPropertyList |
LeadPropertyList |
< LeadPropertyRes > array |
leadSource |
The leadSource(Id) about the lead |
integer(int32) |
leadType |
Type of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Buyer & Seller (3) |
integer(int32) |
leadTypes |
Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7), Homeowner (8), Landlord (9) |
< integer(int32) > array |
leadUserId |
The user Id of the lead |
integer(int64) |
lenderUserId |
The user Id of the lead’s lender |
integer(int64) |
mortgage |
Mortgage, |
string |
opportunity |
The opportunity type of the lead |
string |
phoneStatuses |
The status of the phone number |
< integer(int32) > array |
phones |
The phone list of the lead |
< string > array |
pondId |
The Id of the lead’s pond |
integer(int64) |
pondName |
The Name of the lead’s pond |
string |
preQual |
Pre-qual, |
string |
privateFlag |
The lead is private or not |
boolean |
referredBy |
The referee of the lead |
string |
score |
The score of the lead |
integer(int32) |
segments |
The segments that the lead in |
< string > array |
sellingTimeFrame |
selling time frame, |
string |
source |
The source of the lead |
string |
stage |
The stage of the lead |
string |
stageId |
The stageId of the lead |
integer(int64) |
state |
The state associated with the lead |
string |
streetAddress |
The streetAddress associated with the lead |
string |
tags |
The tags of the lead |
< UserLeadTagVo > array |
teamId |
The teamId of the lead’s team |
integer(int64) |
twitter |
The Twitter account of the lead |
string |
unsubscription |
Unsubscription the email |
boolean |
withBuyerAgent |
With buyer Agent, |
string |
withListingAgent |
With listing agent, |
string |
zipCode |
The zip code associated with the lead |
string |
6.46. LeadTransaction
Name | Description | Schema |
---|---|---|
agentRevenue |
The agent revenue of transaction |
number |
agreementSignedDate |
integer(int64) |
|
appointmentDate |
integer(int64) |
|
appraisalDate |
integer(int64) |
|
assignedAgent |
Lead’s assigned agent (not support updating) |
integer(int64) |
closeDate |
The closed date of transaction |
integer(int64) |
commissionRate |
The commission rate of transaction |
number |
commissions |
Split Commissions |
|
contractDate |
integer(int64) |
|
created |
created time in milliseconds |
integer(int64) |
customFields |
Custom field full coverage update or insertion |
< CustomFieldRequest > array |
escrowDate |
integer(int64) |
|
expectedCloseDate |
The expected close date of transaction |
integer(int64) |
expiration |
integer(int64) |
|
gci |
The GCI of transaction |
number |
homeInspectionDate |
integer(int64) |
|
homePrice |
The home price of transaction |
number |
leadName |
Lead’s name whom the transaction is assigned to (not support updating) |
string |
offerDate |
integer(int64) |
|
teamRevenue |
The team revenue of transaction |
number |
transactionId |
integer(int64) |
|
transactionName |
Property Address/Transaction Name |
string |
transactionStatus |
The status of transaction |
string |
transactionType |
The type of Transaction:Purchase, Listing |
string |
updated |
updated time in milliseconds (not support updating) |
integer(int64) |
6.47. LeadTransactionPropertyAddress
Name | Description | Schema |
---|---|---|
city |
The city |
string |
county |
The county |
string |
label |
The label |
string |
state |
The state |
string |
streetAddress |
The street address |
string |
transactionId |
integer(int64) |
|
unit |
The unit |
string |
zipCode |
The zip code |
string |
6.48. LinkRequest
Name | Schema |
---|---|
leadId |
integer(int64) |
loftyWebsiteURL |
string |
6.49. Location
Name | Description | Schema |
---|---|---|
city |
The city |
string |
county |
The county |
string |
description |
Description of location. |
string |
stateCode |
The state code of city |
string |
streetAddress |
The street address |
string |
zipCode |
The zip code |
string |
6.50. LocationRule
Name | Description | Schema |
---|---|---|
city |
City setting |
string |
county |
County setting |
string |
locationMatchType |
Location match type |
integer(int32) |
state |
State setting |
string |
streetAddress |
StreetAddress setting |
string |
zipcode |
Zipcode setting |
string |
6.51. LogTypeRequest
Name | Description | Schema |
---|---|---|
callingOutcome |
Talked,VoiceMessage,NoAnswer,BadNumber,DNCNumber,DNCContact |
string |
content |
log type content |
string |
isPin |
Pin this activity or not |
boolean |
leadId |
The ID of the lead this log type is related to |
integer(int64) |
leadPhoneNumber |
The value of the lead phone number |
string |
logType |
values:logCall,logEmail,logText |
string |
outboundOrInbound |
Outbound or inbound communication |
string |
6.52. LogTypeResponse
Name | Description | Schema |
---|---|---|
agentId |
Operator’s agent id |
integer(int64) |
callingOutcome |
Calling Outcome value:Talked,VoiceMessage,NoAnswer,BadNumber,DNCNumber,DNCContact |
string |
createTime |
The create time of log type |
string |
id |
The Id of the log type |
integer(int64) |
isPin |
Pin this activity or not |
boolean |
leadId |
The lead(Id) associated with the call/email/text |
integer(int64) |
leadPhoneNumber |
The lead phone number |
string |
outboundOrInbound |
Outbound or inbound communication |
string |
6.53. MemberListResponse
Name | Schema |
---|---|
_metadata |
|
members |
< UserResponse > array |
6.54. MemberWeight
Name | Description | Schema |
---|---|---|
firstName |
Member first name, edit don’t need this param |
string |
lastName |
Member last name, edit don’t need this param |
string |
memberId |
Member id |
integer(int64) |
weight |
Member weight |
integer(int32) |
6.55. MetaData
Name | Description | Schema |
---|---|---|
collection |
The element of the array |
string |
limit |
Quantitative limitation of responded elements |
integer(int32) |
offset |
Start index of the responded elements |
integer(int64) |
scrollId |
Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request. |
string |
total |
The sum of retrieved elements |
integer(int64) |
6.56. MultiTeamInfo
Name | Description | Schema |
---|---|---|
multiTeamId |
Mult-Team ID |
integer(int64) |
multiTeamName |
Multi-Team Name |
string |
6.57. NoteRequest
Name | Description | Schema |
---|---|---|
content |
Note content |
string |
isPin |
Pin this note or not |
boolean |
leadId |
The ID of the lead this note is related to |
integer(int64) |
6.58. NoteResponse
Name | Description | Schema |
---|---|---|
content |
The content of the note |
string |
createTime |
The create time of the note |
string |
creatorId |
The user Id of the note’s creator |
integer(int64) |
creatorName |
The creator’s name of the note |
string |
deleteFlag |
If the note is deleted of not |
boolean |
id |
The Id of the timeline |
integer(int64) |
isPin |
Pin this note or not |
boolean |
lastEditorId |
The last user Id to edit the note |
integer(int64) |
lastEditorName |
The last editor’s name of the note |
string |
lastUpdate |
The last update time of the note |
string |
leadId |
The lead(Id) associated with the note |
integer(int64) |
noteId |
The Id of the note |
integer(int64) |
systemNote |
Is system note or not |
boolean |
6.59. OauthTokenInfo
Name | Description | Schema |
---|---|---|
refreshToken |
refresh token value |
string |
refreshTokenExpireTime |
The expire time of the refreshtoken |
|
token |
token value |
string |
tokenExpireTime |
The expire time of the token |
6.60. OfficeOpenVo
Name | Schema |
---|---|
allowManageSub |
boolean |
city |
string |
email |
string |
id |
integer(int64) |
name |
string |
parentId |
integer(int64) |
phone |
string |
phoneCode |
string |
phoneCountry |
string |
state |
string |
streetAddress |
string |
websiteOwnerId |
integer(int64) |
zipcode |
string |
6.61. OpportunityNotificationRequest
Name | Description | Schema |
---|---|---|
description |
description and link is a combo, only if you fill bath of them, they will show on the notification |
string |
leadId |
the id of lead |
integer(int64) |
link |
description and link is a combo, only if you fill bath of them, they will show on the notification |
string |
message |
the message show on notification |
string |
notificationType |
the notificationType contains flow: |
integer(int32) |
6.62. OrganizationInfo
Name | Description | Schema |
---|---|---|
enterpriseInfo |
If the client is on the "Enterprise Package," the enterprise organization structure will be returned. Refer to "EnterpriseInfo." |
object |
multiTeamInfo |
If the client is on the "Multi-Team Package," the Multi-Team info will be returned. |
object |
orgType |
Organization type |
integer(int64) |
6.63. PageResult
Name | Description | Schema |
---|---|---|
hasMore |
has more |
boolean |
limit |
limit |
integer(int32) |
offset |
current offset |
integer(int32) |
pageData |
page data |
< CommunicationResponse > array |
6.64. PermissionProfile
Name | Description | Schema |
---|---|---|
id |
The Profile Id |
integer(int64) |
name |
The Profile Name |
string |
6.65. PersonalPhotos
Name | Schema |
---|---|
urls |
< string > array |
6.66. Result«long»
Name | Schema |
---|---|
data |
integer(int64) |
errorCode |
integer(int32) |
errorData |
|
errorMsg |
string |
6.67. RoutingRule
Name | Description | Schema |
---|---|---|
activeHours |
Active hours setting |
object |
groupMatchType |
Group match type |
integer(int32) |
groupNames |
Lead segment name list |
< string > array |
id |
Rule id |
integer(int64) |
leadType |
lead type |
string |
leadTypeFilters |
multi lead type |
string |
locationRule |
Location rule |
object |
name |
Rule name |
string |
phone |
Phone setting |
string |
priceMax |
Price max |
integer(int64) |
priceMin |
Price min |
integer(int64) |
routingStrategy |
Active hours setting |
object |
ruleSwitch |
Rule switch |
boolean |
sourceMatchType |
Lead source name |
integer(int32) |
sourceName |
Lead source name |
string |
tagMatchType |
Tag match type |
integer(int32) |
tagNames |
Lead tag name list |
< string > array |
updateTime |
Update time |
integer(int64) |
6.68. RoutingRuleRequest
Name | Description | Schema |
---|---|---|
activeHours |
Active hours setting |
object |
id |
Rule id |
integer(int64) |
routingStrategy |
Active hours setting |
object |
6.69. RoutingStrategy
Name | Description | Schema |
---|---|---|
groupId |
Only lead pond are affected |
integer(int64) |
groupName |
Edit method don’t need this params |
string |
memberWeights |
Except for the lead pond type |
object |
strategyType |
Strategy type |
integer(int32) |
touchMinutes |
Only next up and blast alert are affected |
integer(int32) |
6.70. SocialMedias
Name | Schema |
---|---|
items |
< Item > array |
6.71. SupplementRoutingRule
Name | Description | Schema |
---|---|---|
assigneeAgentId |
Only default assignee are affected |
string |
assigneeAgentName |
Only default assignee are affected |
string |
assigneeGroupId |
Only default assignee are affected |
string |
assigneeGroupName |
Only default assignee are affected |
string |
businessType |
Routing type |
integer(int32) |
roleId |
Role id |
integer(int32) |
strategyType |
Strategy type |
integer(int32) |
touchMinutes |
Only next up and blast alert are affected |
integer(int32) |
updateTime |
Update time |
integer(int64) |
6.72. SupplementRoutingRuleRequest
Name | Description | Schema |
---|---|---|
assigneeAgentId |
Only default assignee are affected |
integer(int64) |
assigneeGroupId |
Only default assignee and routing type is AGENT_LEAD are affected |
integer(int64) |
roleId |
Role id, This parameter is required when type == 4 |
integer(int32) |
strategyType |
Strategy type |
integer(int32) |
touchMinutes |
Only next up and blast alert are affected |
integer(int32) |
6.73. SystemLogResponse
Name | Description | Schema |
---|---|---|
agentId |
The id of the agent |
integer(int64) |
canSticky |
canSticky |
boolean |
content |
content(JSON) |
string |
createTime |
The timestamp of the create time |
integer(int64) |
fromFirstName |
The first name of the FROM |
string |
fromId |
The id of the FROM |
integer(int64) |
fromLastName |
The last name of the FROM |
string |
fromType |
The type of the FROM |
integer(int32) |
id |
id |
integer(int64) |
leadFullName |
The full name of the lead |
string |
leadId |
The id of the lead |
integer(int64) |
sticky |
sticky |
boolean |
timelineTime |
The timestamp of the timeline |
integer(int64) |
timelineType |
The type of the timeline |
integer(int32) |
toFirstName |
The first name of the TO |
string |
toId |
The id of the TO |
integer(int64) |
toLastName |
The last name of the TO |
string |
toType |
The type of the TO |
integer(int32) |
updateTime |
The timestamp of the update time |
integer(int64) |
6.74. TaskRequest
Name | Description | Schema |
---|---|---|
assignedRole |
Role the task should be assigned to (Agent Or Assistant) |
string |
content |
Description of the task |
string |
deadline |
Deadline of the task |
integer(int64) |
leadId |
The ID of the lead this task is related to. |
integer(int64) |
type |
The type of the task. Could be |
string |
6.75. TaskResponse
Name | Description | Schema |
---|---|---|
assignedRole |
The role of the task assigned to |
string |
assignedUser |
The user of the task assigned to |
string |
assignedUserId |
The user’s Id of the task assigned to |
integer(int64) |
body |
The body of the task |
string |
content |
The content of the task |
string |
createTime |
The create time of the task |
string |
creatorId |
The creator’s Id of the task |
integer(int64) |
deadline |
The deadline of the task |
string |
deleteFlag |
If the task is deleted or not |
boolean |
finishFlag |
If the task is finished or not |
boolean |
finishTime |
The finish time of the task |
string |
id |
The Id of the task |
integer(int64) |
lastUpdate |
The last update time of the task |
string |
leadEmail |
The lead’s email associated with the task |
string |
leadFirstName |
The lead’s first name of the task |
string |
leadId |
The lead(Id) associated with the task |
integer(int64) |
leadLastName |
The lead’s last name of the task |
string |
leadName |
The lead’s name associated with the task |
string |
leadPhone |
The lead’s phone associated with the task |
string |
leadUserId |
The lead’s user Id associated with the task |
integer(int64) |
overdueFlag |
If the task is overdue or not |
boolean |
pipelineId |
The pipeline(Id) of the associated lead |
integer(int64) |
queryId |
The queryId of the task |
integer(int64) |
queryInfo |
The queryInfo of the task |
string |
reminderType |
The reminder’s type of the task |
integer(int32) |
subject |
The subject of the task |
string |
teamId |
The team’s Id associated with the task |
integer(int64) |
type |
The type of the task |
string |
6.76. TextResponse
Name | Description | Schema |
---|---|---|
agentId |
The related Agent ID |
integer(int64) |
direction |
Outbound or Inbound text |
string |
id |
The ID of the text |
integer(int64) |
leadId |
The lead(Id) associated with the text |
integer(int64) |
textOutcome |
Text delivery status |
string |
textTime |
The sending time of the text |
string |
textType |
Manual or Auto text |
string |
6.77. Timestamp
Name | Schema |
---|---|
date |
integer(int32) |
day |
integer(int32) |
hours |
integer(int32) |
minutes |
integer(int32) |
month |
integer(int32) |
nanos |
integer(int32) |
seconds |
integer(int32) |
time |
integer(int64) |
timezoneOffset |
integer(int32) |
year |
integer(int32) |
6.78. UserLeadTag
Name | Schema |
---|---|
createTime |
string(date-time) |
creatorUserId |
integer(int64) |
leadId |
integer(int64) |
tagId |
integer(int64) |
tagName |
string |
updateTime |
string(date-time) |
visibleType |
integer(int32) |
6.79. UserLeadTagVo
Name | Schema |
---|---|
createTime |
string |
creatorUserId |
integer(int64) |
leadId |
integer(int64) |
tagId |
integer(int64) |
tagName |
string |
updateTime |
string |
visibleType |
integer(int32) |
6.80. UserRequest
Name | Description | Schema |
---|---|---|
agentInfo |
The agent infomation of the user |
|
email |
The email of the member |
string |
firstName |
The firstName of the member |
string |
headPortrait |
The head portrait of the member |
string |
lastName |
The lastName of the member |
string |
phoneNumber |
The phone number of the member |
string |
timeZoneId |
The time zone of the member. timeZoneId: "America/Halifax", |
string |
6.81. UserResponse
Name | Description | Schema |
---|---|---|
accountStatus |
string |
|
agentInfo |
The agent infomation of the user |
|
assignedLeadCount |
The count about assigned leads of the member |
integer(int32) |
email |
The email of the member |
string |
firstLetter |
The firstLetter of the member |
string |
firstName |
The firstName of the member |
string |
groupId |
The group id of the member |
integer(int64) |
groupName |
The group name of the member |
string |
id |
The Id of the team’s member |
integer(int64) |
invitorUserId |
The user Id of the member invited by |
integer(int64) |
isAdmin |
If the member is admin or not |
boolean |
lastName |
The lastName of the member |
string |
memberUserId |
The user Id of the member |
integer(int64) |
newLeadCount |
The count about new leads of the member |
integer(int32) |
phoneNumber |
The phone number of the member |
string |
role |
The role(Id) of the member |
integer(int32) |
roleName |
The role(name) of the member |
string |
status |
The status of the member |
integer(int32) |
timeZoneId |
The agent timezoneId |
string |
virtualNumber |
The virtual number of the member |
string |
6.82. VendorInfo
Name | Description | Schema |
---|---|---|
agentUserId |
Agent user ID |
integer(int64) |
companyAddress |
The company name of the vendor |
string |
companyName |
The company name of the vendor |
string |
email |
The email of the vendor |
string |
firstName |
The first name of the vendor |
string |
id |
The ID of the vendor |
integer(int64) |
lastName |
The last name of the vendor |
string |
phoneCode |
The phone code of the vendor |
string |
phoneCountry |
The phone country of the vendor |
string |
phoneNumber |
The phone number of the vendor |
string |
roleName |
The role name of the vendor |
string |
6.83. VisibleOrgInfo
Name | Description | Schema |
---|---|---|
groupId |
Group ID |
integer(int64) |
groupName |
Group Name |
string |
parentId |
Parent Group ID |
integer(int64) |
6.84. WebhookRequest
Name | Description | Schema |
---|---|---|
callbackUrl |
The url link that you receive information |
string |
limit |
limitation of webhook notifications in 30 mins for each, max is 5000 |
integer(int32) |
listId |
The list that you want to subscribe. |
integer(int32) |
6.85. WebhookResponse
Name | Description | Schema |
---|---|---|
callbackUrl |
The url link that you receive information |
string |
limit |
limitation of webhook notifications in 30 mins for each, max is 5000 |
integer(int32) |
listId |
The ID of the list to get |
integer(int32) |
subscribeId |
the subscribe id |
integer(int64) |
teamId |
The ID of the team to get |
integer(int64) |
vendorId |
The ID of the vendor |
integer(int64) |
6.86. WorkInfo
Name | Description | Schema |
---|---|---|
address |
address of the agent |
string |
companyAddress |
Company Address |
string |
companyName |
Company Name |
string |
licenseId |
licenseId of the agent |
string |
personalAttachments |
< FileInfo > array |
|
personalDisclaimers |
< FileInfo > array |
|
personalIntroduction |
Personal Introduction |
string |
personalWebsite |
Personal Website |
string |
position |
position |
string |