1. Overview

This is the restricted documentation for Creating, Retrieving, and Updating SkySlope Listings and Sales.

1.1. FAQ

Who do I contact for help?

The best resource for help is the SkySlope Support team. They can be reached at 1-800-507-4117 or by visiting support.skyslope.com to connect via chat.

How do I get setup?

Reach out to your Customer Success Manager to get setup with the SkySlope APIs. Once an order form has been signed, your Customer Success Manager will provide you with your testing account as well as your Client Id and Secret.

Where do I get the Client Id and Secret?

Your Customer Success Manager will assist with providing the Client Id and Secret in a password protected zip file. The password to access the zip file will be shared separately with your primary technical contact.

Where do I get the access key and secret for a user?

The Access Key and Secret must be generated by each user from within their own SkySlope account. Detailed instructions on how to generate an Access Key and Secret are provided in Section 1.3.2 of this documentation.

How do the Access Key and Secret work for each user?

The Access Key and Secret are generated at the user level and provide the same level of access that the user would have in their SkySlope account. For example, if you are using the Access Key and Secret of an Agent account, then you will only be able to pull data for Listings and Sales that belong to that Agent. If you need access to all files within a brokerage, you would want to use the Access Key and Secret of a Broker or Admin who has access to all files.

How can I get help authenticating?

Section 1.3.3 of this documentation provides instructions on how to authenticate as well as some code examples for generating an HMAC. For an authentication example with video walkthrough please check out this code repository and video. If you need additional assistance authenticating, please reach out to the SkySlope Support Team.

Do I need to get each agent’s authentication?

Yes for security reasons and compliance of the audit log, each user has their own Access Key and Secret they need to provide to integrate.

As a vendor, do I need to get access from each brokerage?

Yes. You are required to get access from each brokerage.

What do I have to do if I want to access multiple brokerages?

You will need to get the Access Key and Secret of each user from each brokerage that you wish to work with.

How can I generate test data in my SkySlope test account to be used with the API?

When your test account is provided, it will not have any Listings or Sales populated. You can manually create property files from within the account or you can utilize the file creation scripts provided here to generate some test files.

Do we have access to pull all fields?

Yes, you can pull all fields of the user you are integrated with using the Bulk Export endpoint. For an example of how to use the Bulk Export with video walkthrough please check out this code repository and video

Are we able to only pull certain fields?

Yes, our GraphQl endpoint can return the same data as the Bulk Export but if you do not need all of the data then you can specify which fields will come back in your response. More information for GraphQl can be found here with a video tutorial here.

What are your rate limits?

By default each Client Id is limited to 100 requests per minute. If you run into issues hitting the limit, you can utilize the rate limit headers returned in each response to know when to wait. More information about this in Section 1.4.1 of this documentation.

Do you offer webhooks?

No, we do not offer webhooks.

Where can I get a swagger or OpenAPI definition for SkySlope API?

You can download our Swagger.json.

How can I tell if the SkySlope API is down?

GET /api/healthcheck will return a 200 OK if everything is ok.

1.2. Getting started

For a quick overview of creating, updating, and viewing a sale with the API, see Example flow

1.3. Authentication

There are two sets of credentials used to authentication in the SkySlope APIs.

  • ClientID and ClientSecret

  • AccessKey and Secret

Using these 4 pieces of information, an integration can authenticate as that user and be issued a Session token, which is used for all further api calls.

1.3.1. How to get your ClientID and Client Secret

During onboarding, SkySlope will send you a password protected zip file with your ClientID and ClientSecret pair. These client credentials identify your 3rd party app to SkySlope. They are used to identify your integration to our systems, and function as a Username / Password combo for your app.

1.3.2. How to get an Access Key and Secret

An AccessKey and Secret are issued for each user. These credentials function as a Username / Password combo for that user. An AccessKey issued by a user has the same level of privilege and access as that same user would in SkySlope. So authenticating with the AccessKey and Secret of an agent means you can only access the data that agent has access to and follow the same rules that user follows.

Within SkySlope, click on My Account under the SkySlope menu icon.

1 Navigate to access keys

Once in My Account, click on the Integrations tab.

2 Access keys list

Click the Generate New Key button. An Access Key and a Secret key will be created and you will see a message similar to the following:

If you don’t see this Generate New Key button then you may be looking at the integrations tab for your broker in the Admin section. You want the integrations tab for you and your account. Look for My Account under the SkySlope menu icon.

3 Access key confirmation

You can download your new keys by clicking the Download Key & Secret button. This is the only opportunity you will have to see the Secret key.

Click the Close button to return to the Access Key list. The new Access Key will show in the list.

4 Access key added to list

If you wish a particular Access Key to be deleted, find the key in the list and click the Delete Key button. You will be prompted to confirm.

5 Delete confirmation

Clicking Ok will remove the Access Key from your list.

1.3.3. How to Authenticate

A SkySlope API session is initiated by posting to https://api.skyslope.com/auth/login with the following payload:

{
	"clientID": <your clientId>,
	"clientSecret": <your clientSecret>
}

The following headers must also be included:

  • Content-Type: application/json

  • Authorization: SS <AccessKey>:<HMAC>

  • Timestamp: <Timestamp>

Content-Type header

The login endpoint only accepts json post payloads

Authorization header

The Authorization header uses the scheme SS (for SkySlope) and is composed of the user’s AccessKey and a base-64 encoded HMAC value.

The HMAC for the request is computed using the user’s AccessSecret as the key and the following additional information as the input:

<ClientID>:<ClientSecret>:<Timestamp>
C# example

The exact code to compute an HMAC varies from programming language to programming language. Here is an example in C#:

string clientId = "sample", clientSecret = "sample", accessKey = "SKYSAMPLESAMPLESAMPL", accessSecret = "SAMPLE", timestamp = "2000-01-01T01:01:01Z";

var key = Encoding.UTF8.GetBytes(accessSecret);
var input = $"{clientId}:{clientSecret}:{timestamp}";
var hmacBytes = new HMACSHA256(key).ComputeHash(Encoding.UTF8.GetBytes(input));
var hmac = Convert.ToBase64String(hmacBytes);
var authHeader =  "SS " + accessKey + ":" + hmac;

This should produce the following hmac hash, converted to base 64:

QPpNul0R2u/Hy16vuTnal4mnJ78fU1QPf2Dg/Qr/5Ig=

Therefore, the resulting value of the Authorization header would be:

Authorization: SS SKYSAMPLESAMPLESAMPL:QPpNul0R2u/Hy16vuTnal4mnJ78fU1QPf2Dg/Qr/5Ig=
node.js example

Here is an example using node and the built-in crypto library:

const clientId = "sample", clientSecret = "sample", accessKey = "SKYSAMPLESAMPLESAMPL", accessSecret = "SAMPLE", timestamp = "2000-01-01T01:01:01Z";

const crypto = require('crypto');
const hmac = crypto.createHmac("sha256", accessSecret)
  .update(clientId + ":" + clientSecret + ":" + timestamp)
  .digest("base64");
const authHeader =  "SS " + accessKey + ":" + hmac;

This should produce the following hmac hash, converted to base 64:

QPpNul0R2u/Hy16vuTnal4mnJ78fU1QPf2Dg/Qr/5Ig=

Therefore, the resulting value of the Authorization header would be:

Authorization: SS SKYSAMPLESAMPLESAMPL:QPpNul0R2u/Hy16vuTnal4mnJ78fU1QPf2Dg/Qr/5Ig=
bash example

An example bash script using curl to authenticate:

TIMESTAMP=$(date -u "+%Y-%m-%dT%TZ")
HMAC=$(echo -n "$CLIENT_ID:$CLIENT_SECRET:$TIMESTAMP" | openssl sha256 -binary -hmac "$ACCESS_SECRET" | base64)
curl -X POST \
  -H "Authorization: SS $ACCESS_KEY:$HMAC" \
  -H "Content-Type: application/json" \
  -H "Timestamp: $TIMESTAMP" \
  --data "{\"ClientId\":\"$CLIENT_ID\",\"ClientSecret\":\"$CLIENT_SECRET\"}" \
  https://api.skyslope.com/auth/login
Timestamp header

The Timestamp header is used as part of the data passed to the SHA256 HMAC. In order for the server to know what value was used, it must also be passsed as a Timestamp header. The format for the Timestamp header is RFC3339 and should be computed for the timezone UTC-0, aka UTC time.

The timestamp used needs to be within 5 minutes [1] of UTC now after which a new HMAC must be generated.

Authentication response

The post to /auth/login responds with a Session ticket. This value is used to correlate requests with the specific user context used to authenticate. The return value is passed as a Sesssion header on all subsequent calls.

The session expires after 2 hours [2]. Once it expires, all requests will return a 403 Unauthorised status. You’ll need to get a new session by posting to /auth/login again.

An example of the Session ticket response:

{"Session":"fe17fd08cf9fc17b7440d35b9b6d5d4429a2089f08b8b3f1faddcc5e56490920","Expiration":"2019-07-11T20:34:50Z"}

For example, to create a listing you would use this url:

POST api/listing

and include the following header:

Session: fe17fd08cf9fc17b7440d35b9b6d5d4429a2089f08b8b3f1faddcc5e56490920

The Example flow section has an in depth example of how the urls work.

1.4. Requests

All requests should include the Content-Type: application/json header as well as the authentication header.

Some resources have forms describing what’s needed to create, add, or update the resource. Since that can be configured and changed at any time, it’s best to get the form to determine what’s required and what the valid values are. The description of the resource will indicate if there are forms or not.

1.4.1. Rate limiting

Each clientId is allowed a certain number of requests for each window of time. By default 100 requests per minute.

Each response from the api will have three headers explaining how many requests you can make:

x-ratelimit-limit indicates how many requests can be made for each window of time.

x-ratelimit-reset indicates when the next window of time starts expressed as the number of seconds since 1970-01-01.

x-ratelimit-remaining indicates how many requests remain until the x-ratelimit-reset time.

So, if you have these response headers:

  x-ratelimit-limit: 100
  x-ratelimit-remaining: 0
  x-ratelimit-reset: 1614290760

That means you’ve run out of requests until new Date(1614290760 * 1000).toISOString(), which is 2021-02-25T22:06:00.000Z. At that time you’ll get another 100 requests.

1.5. Responses

All responses will include the Content-Type: application/json; charset=utf-8 header.

Standard HTTP status codes are used for responses.

API responses follow HATEOAS and include a links section to further requests. That shows up as LinkedResponseOf in the definitions.

1.5.1. Success

All 200 status responses will have a values object and a links collection. The values will contain whatever data you requested or whatever is relevant to your request. The links will contain references to related requests that you may be interested in.

// Status: 200 OK
{
  "values": { (1)
    "listingGuid": "049a59b1-7335-468b-8e1d-5c46d271bed6"
  },
  "links": [ (2)
    {
      "method": "GET",
      "ref", "listing:updateForm",
      "api/files/listings/049a59b1-7335-468b-8e1d-5c46d271bed6/updateForm"
    }
  ]
}
1 The values object. In this case a listingGuid is returned.
2 The links collection. In this case a link to get the update listing form is returned.

1.5.2. Errors

Any 400 status response will not have a value or links section, there will be an errors collection instead.

// Status: 422 UnprocessableEntity
{
  "errors": ["First name is required", "Last name is required"]
}
// Status: 404 NotFound
{
  "errors": ["Unable to find office with guid: 06fdc276-f5b3-4bba-b144-770139e6b798"]
}

A 422 UnprocessableEntity status is returned if the data is invalid. A 404 NotFound status is returned if the url is unknown or the user making the request does not have access to the sale or listing they are requesting.

1.5.3. Deprecation

If a resource is deprecated then the response will include a Deprecation and Link header in accordance with the proposed deprecation header standard. The Link will contain the url that replaces the deprecated resource.

Deprecation: version=2019-05-01
Link: <api/subscribers/3b89dca3-7de3-465c-82dd-1401d8161a12/users/{userGuid}/sales/d30c10f4-5e64-4a58-8894-c1b7b402b3a9>; rel="successor-version"

1.6. Security

Cross-Site Scripting (XSS) attacks occur when an attacker uses a web application to send malicious code, generally in the form of a browser side script, to a different end user.

Requests with obvious script injection will be rejected with a 422 UnprocessableEntity status. However, it is still your organization’s responsibility to sanitize request payloads and responses.

1.7. Example flow

Here’s an example of creating, updating, then viewing a sale through the API.

The authorization header must be present for each request.

First, you need to get the form which explains what fields are required to create a sale. Since what required fields are configurable and can change at any time, you should get the form any time you want to create a sale.

To learn more about which fields can be customized by your brokerage, see Field Configuration.

// GET /api/files/saleForm

// Response 200 OK:
{
    "value": {
        "fields": [  (1)
            {
                "fieldName": "OfficeGuid", (2)
                "fieldType": "Nullable<Guid>",
                "isRequired": true,
                "subFields": null,
                "allowableSelections": null,
                "description": "Office guid that the sale will be created in."
            },
            {
                "fieldName": "AgentGuid", (3)
                "fieldType": "Nullable<Guid>",
                "isRequired": true,
                "subFields": null,
                "allowableSelections": null
            },
            {
                "fieldName": "LoanTypeId",
                "fieldType": "Nullable<int>",
                "isRequired": false,
                "subFields": null,
                "allowableSelections": [ (4)
                    {
                        "id": 75,
                        "name": "Home Loan"
                    },
                    {
                        "id": 76,
                        "name": "Personal Loan"
                    },
                    {
                        "id": 249,
                        "name": "Conventional"
                    },
                    {
                        "id": 250,
                        "name": "VA"
                    },
                    {
                        "id": 251,
                        "name": "FHA"
                    },
                    {
                        "id": 252,
                        "name": "Other"
                    }
                ],
                "description": null,
                "deprecated": false,
                "deprecatedAsOf": null,
                "deprecatedAvailableSelections": false,
                "deprecatedAvailableSelectionsAsOf": null
            },
            /*
            Many other fields ...
            */
        ]
    },
    "links": [ (5)
        {
            "href": "api/files/sales",
            "rel": "sale",
            "method": "POST"
        }
    ]
}
1 A list of fields are returned.
2 The OfficeGuid is a required guid.
3 The AgentGuid is a required guid.
4 A list of valid loanTypeIds is included.
5 A link to create a sale is included.

The create sale form shows that you’ll need to supply an agent, office, checklist type, and other data.

First, get an agent.

// GET /api/subscribers

// Response 200 OK:
{
    "value": {
        "isMultiOffice": true,
        "users": [ (1)
            {
                "userGuid": "f046c48f-ede1-4ba0-92a7-18b75acfcbc6",
                "firstName": "Example",
                "lastName": "Agent",
                "email": "[email protected]",
                "userType": "Agent"
            },
            {
                "userGuid": "00ad5908-0631-4f94-95e8-ad79dd89dc1e",
                "firstName": "Another",
                "lastName": "User",
                "email": "[email protected]",
                "userType": "Auditor"
            },
        ],
        "transactionTypes": [ (2)
            "Listing",
            "Sale"
        ]
    },
    "warnings": null,
    "links": [ (3)
        {
            "href": "api/offices",
            "rel": "listing:office",
            "method": "GET"
        },
        {
            "href": "api/files/listingForm?userGuid={userGuid}&checklistTypeId={checklistTypeId}",
            "rel": "listing:form",
            "method": "GET"
        },
        {
            "href": "api/files/saleForm?userGuid={userGuid}&checklistTypeId={checklistTypeId}",
            "rel": "sale:form",
            "method": "GET"
        }
    ]
}
1 A list of users is returned.
2 Available transaction types are returned.
3 A links to get offices, get the create listing form, and get the create sale form are included.

Once you choose which user you want to assign to the new sale, get the list of offices.

// GET /api/offices

// Response 200 OK:
{
    "value": { (1)
        "offices": [
            {
                "officeGuid": "98edd06b-b87a-48ea-b1a5-26b3910ea459",
                "officeName": "First Office"
            },
            {
                "officeGuid": "0e487c18-980c-45f0-bdcd-64c3d6220f08",
                "officeName": "Second Office"
            }
        ]
    },
    "links": [ (2)
        {
            "href": "api/offices/{officeId}/checklistTypes",
            "rel": "office:checklistTypes",
            "method": "GET"
        }
    ]
}
1 A list of offices are returned.
2 A link to get the checklists for an office is included.

And now that you have the office (we’ll use 98edd06b-b87a-48ea-b1a5-26b3910ea459 in this example), get the sale checklist types for that office.

// GET /api/offices/98edd06b-b87a-48ea-b1a5-26b3910ea459/checklistTypes?transactionType=Sale

// Response 200 OK:
{
    "value": { (1)
        "checklistTypes": [
            {
                "checklistTypeId": 108,
                "checklistTypeName": "Mobile home park"
            },
            {
                "checklistTypeId": 107,
                "checklistTypeName": "Multi-Unit"
            }
        ]
    },
    "links": [ ] (2)
}
1 A list of checklist types are returned.
2 There are no links.

Now that you have all the required data, you can create a new sale based on the createSaleForm.

// POST /api/files/sales
{
  {
    "officeGuid": "98edd06b-b87a-48ea-b1a5-26b3910ea459",
    "agentGuid": "f046c48f-ede1-4ba0-92a7-18b75acfcbc6",
    "checklistTypeId": 108,
    /* other fields */
  }
}

// Response 200 OK:
{
    "value": { (1)
        "saleGuid": "d30c10f4-5e64-4a58-8894-c1b7b402b3a9"
    },
    "links": [ (2)
        {
            "href": "api/files/sales/d30c10f4-5e64-4a58-8894-c1b7b402b3a9",
            "rel": "sale",
            "method": "GET"
        },
        {
            "href": "api/files/sales/d30c10f4-5e64-4a58-8894-c1b7b402b3a9/updateSalePropertyForm",
            "rel": "sale:property",
            "method": "GET"
        },
        /*
        Many other links ...
        */
    ]
}
1 The guid of the sale that was just created.
2 Many links to view and update the sale are included.

The sale is incomplete until you add commission data and contacts.

You can get the form that describes what fields are required to add commission data at /api/files/sales/:saleGuid/addCommissionsToSaleForm.

For each contact, you can get the form that describes what’s required to add contacts and how to add them. For example, /api/files/sales/:saleGuid/addSellerContactToSaleForm describes which fields are required for adding seller contacts.

That’s a quick overview of how to login as a specific user then create a complete sale as that user. The rest of this documentation shows the details of each resource.

2. Bulk Export

Get all sales and listings. You can filter by created date, modified date, closed date, status, address, and the email of the sale or listing. The results are streamed back in chunks that you can process one a a time. If a chunk begins with "{" and ends with "},\n" then you can remove the trailing comma and new line and you’ll have a valid json object. If you want to get all sales and listings that have been modified in the last 30 minutes, and it’s currently 2019-10-1 at 8:30 UTC, you could do this:

GET /api/files?modifiedAfter=2019-10-1T08:00:00

If you want all the incomplete sales, you could do this:

GET /api/files?createdAfter=2000-01-01&status=incomplete&type=sale

If you do not specify a date filter, the results will default to files created within the last 7 days.

2.1. Statuses

active (listing)

listing where current date is less than expiration date

archived (sale)

a sale that has been closed and archived by an auditor (done & agent paid typically)

canceledApproved (listing or sale)

cancellation that has been approved

canceledPending (listing or sale)

agent has submitted for cancellation approval

closed (sale)

a sale that has been closed by an auditor

expired (listing or sale)

listing or sale past expiration or closing date

incomplete (listing or sale)

missing details needing to be filled in by agent

pending (sale)

sale where current date is less than closing date

2.2. Bulk Export Objects

The Bulk Export endpoint can return 3 different objects. Each object can be distinguished by the objectType attribute. There are 3 types: summary, sale and listing (See Bulk Export query parameters).

2.2.1. Summary Object

This object describes the summary of the Bulk Export response.

Name Description Schema

objectType

The type of the object.

string

numberOfSales

The number of sales.

integer

numberOfListings

The number of listings.

integer

numberOfUsers

The number of users.

integer

createdOn

The date that this request was made.

string (date-time)

2.2.2. Listing Object

This object describes a SkySlope listing.

Name Description Schema

objectType

The type of the object.

string

listingGuid

The GUID for this listing.

string (guid)

agentGuid

string (guid)

createdByGuid

string (guid)

coListingAgentGuid

string (guid)

referringAgentGuid

string (guid)

mlsNumber

string

status

string

modifiedOn

string (date-time)

officeId

integer

officeGuid

string (guid)

checklistType

string

type

string

listingDate

string (date-time)

source

string

otherSource

string

fileId

string

commission

CommissionDTO

expirationDate

string (date-time)

company

string

listingPrice

number (decimal)

email

string

property

PropertyDTO

commercialLease

CommercialLeaseDTO

sellers

< SellerDTO > array

homeWarrantyContact

HomeWarrantyContactDTO

miscContact

MiscellaneousContactDTO

stage

StageDTO

coAgentGuids

< string (guid) > array

agent

< object > array

coAgents

< object > array

customFields

object

createdOn

string (date-time)

2.2.3. Sale Object

This object describes a SkySlope Transaction.

Name Description Schema

objectType

The type of the object.

string

saleGuid

The GUID for this sale.

string (guid)

listingGuid

The GUID for the listing that this sale was converted from.

string (guid)

agentGuid

string (guid)

createdByGuid

string (guid)

mlsNumber

string

escrowNumber

string

statusId

integer

status

string

officeId

integer

officeGuid

string (guid)

checklistType

string

escrowClosingDate

string (date-time)

actualClosingDate

string (date-time)

contractAcceptedDate

string (date-time)

modifiedOn

string (date-time)

source

string

otherSource

string

dealType

The side of the deal the agent represents.

string

listingPrice

number (decimal)

salePrice

number (decimal)

isOfficeLead

boolean

coBrokerCompany

string

email

string

property

PropertyDTO

commission

CommissionDTO

sellers

< SellerDTO > array

buyers

< BuyerDTO > array

titleContact

TitleContactDTO

escrowContact

EscrowContactDTO

attorneyContact

< AttorneyContactDTO > array

lenderContact

LenderContactDTO

otherSideAgentContact

OtherSideAgentContactDTO

homeWarrantyContact

HomeWarrantyContactDTO

miscContact

MiscellaneousContactDTO

commercialLease

CommercialLeaseDTO

commissionBreakdowns

< CommissionBreakdownDTO > array

coAgentGuids

< string (guid) > array

commissionSplits

< CommissionSplitsDTO > array

stage

StageDTO

commissionReferral

CommissionReferral

agent

< object > array

coAgents

< object > array

earnestMoneyDeposit

EarnestMoneyDepositDTO

customFields

object

createdOn

string (date-time)

2.3. Get sales & listings

GET /api/files

2.3.1. Parameters

Type Name Description Schema Default

Query

closedAfter
optional

string (date-time)

Query

closedBefore
optional

string (date-time)

Query

createdAfter
optional

string (date-time)

Query

createdBefore
optional

string (date-time)

Query

email
optional

The email of the listing or sale.

string

Query

modifiedAfter
optional

string (date-time)

Query

modifiedBefore
optional

string (date-time)

Query

propertyAddress
optional

A search parameter that is a substring of the property address of the listing or sale. For example, propertyAddress=sacra will find files in the city Sacramento or on Sacramento St.

string

Query

status
optional

A comma separated list whose items can be all, active, pending, closed, incomplete, expired, canceledPending, canceledApproved, and archived and defaults to all.

string

"all"

Query

type
optional

A comma separated list whose items can be all, sale, listing, or summary, and defaults to all.

string

"all"

2.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetBulkExportResponse

404

ErrorObject

422

ErrorObject

3. Checklists

The checklist type determines which fields are available. A checklist type belongs to an office and can only be used for a sale or a listing - not both.

There’s a separate endpoint for single office brokers. Most brokers do not need to use that one.

3.1. List all (single office)

GET /api/checklistTypes

3.1.1. Parameters

Type Name Description Schema

Query

transactionType
optional

The type of transaction you want to get checklist types for. The Subscribers endpoint describes what the valid transaction types are.

enum (Listing, Sale)

3.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetChecklistTypesResponse2

404

ErrorObject

422

ErrorObject

3.2. List checklist types

GET /api/offices/{officeGuid}/checklistTypes

3.2.1. Parameters

Type Name Description Schema

Path

officeGuid
required

The office you want to get checklist types for

string (guid)

Query

transactionType
optional

The type of transaction you want to get checklist types for. The Subscribers endpoint describes what the valid transaction types are.

enum (Listing, Sale)

3.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetChecklistTypesResponse

404

ErrorObject

422

ErrorObject

4. Contacts

These are the contacts in your directory. You’ll get a warning if adding a contact when another contact with the same first and last name, email, address, phone, alternate phone already exists.

4.1. Create contact

POST /api/contacts

4.1.1. Parameters

Type Name Schema

Body

form
required

DirectoryContactForm2

4.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfCreateDirectoryContactResponse

404

ErrorObject

422

ErrorObject

4.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

4.2. Get contacts

GET /api/contacts

4.2.1. Parameters

Type Name Schema

Query

alternatePhone
optional

string

Query

city
optional

string

Query

company
optional

string

Query

email
optional

string

Query

fax
optional

string

Query

firstName
optional

string

Query

lastName
optional

string

Query

phone
optional

string

Query

state
optional

string

Query

streetName
optional

string

Query

streetNumber
optional

string

Query

zip
optional

string

4.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetContactsResponse

404

ErrorObject

422

ErrorObject

4.3. Delete a contact

DELETE /api/contacts/{contactGuid}

4.3.1. Parameters

Type Name Schema

Path

contactGuid
required

string (guid)

4.3.2. Responses

HTTP Code Schema

204

No Content

404

ErrorObject

422

ErrorObject

4.4. Update a contact

PATCH /api/contacts/{contactGuid}

4.4.1. Parameters

Type Name Schema

Path

contactGuid
required

string (guid)

Body

form
required

DirectoryContactForm

4.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetContactsResponse

404

ErrorObject

422

ErrorObject

4.4.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

5. Earnest Money Deposit

A sale can have earnest money deposit associated with it.

5.1. Update deposit

PATCH /api/files/sales/{saleGuid}/earnestMoneyDeposit

5.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Query

AdditionalDepositAmount
optional

number (decimal)

Query

AdditionalDepositDueDate
optional

string (date-time)

Query

DateOfCheck
optional

string (date-time)

Query

DatePostedToLogBook
optional

string (date-time)

Query

DepositAmount
optional

number (decimal)

Query

DepositDueDate
optional

string (date-time)

Query

IsEarnestMoneyHeld
optional

boolean

5.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfPatchEarnestMoneyDepositResponse

404

ErrorObject

422

ErrorObject

6. Listing Agents

Each listing has one and only one primary agent assigned to it. If you want to assign co agents, look at Listing Co Agents.

6.1. Update agent

PUT /api/files/listings/{listingGuid}/agent

6.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The agent you want to update.

string (guid)

Body

form
required

UpdateListingAgentForm

6.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingAgentResponse

404

ErrorObject

422

ErrorObject

6.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

7. Listing Checklist Types

A listing must have one checklist type. The checklist type determines which fields are available. The listing’s office determines which checklist types are available.

You can not update a listing with a "Commercial Lease" checklist type to have a non-"Commercial Lease" checklist type or the other way around.

See Checklists for more info on checklists.

7.1. Update checklist type

PUT /api/files/listings/{listingGuid}/checklistType

7.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

Body

form
required

UpdateListingChecklistTypeForm

7.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingChecklistTypeResponse

404

ErrorObject

422

ErrorObject

7.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

8. Listing Co Agents

A listing can have from zero up to 5 co agents assigned. If you want to update the primary agent assigned, see Listing Agents.

8.1. Update co agents

PUT /api/files/listings/{listingGuid}/coAgents

8.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

Body

form
required

UpdateListingCoAgentsForm

8.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingCoAgentsResponse

404

ErrorObject

422

ErrorObject

8.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

8.2. Get update form

GET /api/files/listings/{listingGuid}/updateListingCoAgentsForm

8.2.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

8.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateListingCoAgentsFormResponse

404

ErrorObject

422

ErrorObject

9. Listing Commission Referral

A listing can have commission referral data associated to it.

9.1. Add commission referral

POST /api/files/listings/{listingGuid}/commissionReferral

9.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

string (guid)

Body

form
required

The form with commission referral data you want to add.

AddCommissionReferralToListingForm

9.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddCommissionReferralToListing

404

ErrorObject

422

ErrorObject

9.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

9.2. Update commission referral

PATCH /api/files/listings/{listingGuid}/commissionReferral

9.2.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

Body

form
required

The form with commission referral data you want to update.

PatchListingCommissionReferralForm

9.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddCommissionReferralToListing

404

ErrorObject

422

ErrorObject

9.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

9.3. Get form

GET /api/files/listings/{listingGuid}/commissionReferralForm

9.3.1. Parameters

Type Name Schema

Path

listingGuid
required

string (guid)

9.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetListingCommissionReferralFormResponse

404

ErrorObject

422

ErrorObject

10. Listing Commissions

A listing can have commission data associated to it.

Be sure to get the addCommissionsToListingForm before adding and the updateListingCommissionsForm before updating commission data since some fields can be configured to be required or not and that can change at any time.

10.1. Get add form

GET /api/files/listings/{listingGuid}/addCommissionsToListingForm

10.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to add commissions to.

string (guid)

10.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddCommissionToListingFormResponse

404

ErrorObject

422

ErrorObject

10.2. Add commissions

POST /api/files/listings/{listingGuid}/commissions

10.2.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to add commissions to.

string (guid)

Body

form
required

The form with commissions you want to add.

AddCommissionToListingForm

10.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddCommissionToListingResponse

404

ErrorObject

422

ErrorObject

10.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

10.3. Update commissions

PUT /api/files/listings/{listingGuid}/commissions

10.3.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

Body

form
required

The form with commissions you want to update.

UpdateListingCommissionsForm

10.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddCommissionToListingResponse

404

ErrorObject

422

ErrorObject

10.3.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

10.4. Get update form

GET /api/files/listings/{listingGuid}/updateListingCommissionsForm

10.4.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

10.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateListingCommissionsFormResponse

404

ErrorObject

422

ErrorObject

11. Listing Contacts

A listing can have several different contacts associated with it: up to 5 seller contacts, up to one home warranty contact, and any number of miscellaneous contacts.

Be sure to get the addContactsToListingForm before adding and the updateListingContactForm before updating a contact since some fields can be configured to be required or not and that can change at any time.

11.1. Get add form

GET /api/files/listings/{listingGuid}/addHomeWarrantyContactToListingForm

11.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

11.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddHomeWarrantyToListingFormResponse

404

ErrorObject

422

ErrorObject

11.2. Get add form

GET /api/files/listings/{listingGuid}/addMiscellaneousContactToListingForm

11.2.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

11.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddMiscellaneousContactToListingFormResponse

404

ErrorObject

422

ErrorObject

11.3. Get add form

GET /api/files/listings/{listingGuid}/addSellerContactToListingForm

11.3.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

11.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddSellerToListingFormResponse

404

ErrorObject

422

ErrorObject

11.4. Update contact

PUT /api/files/listings/{listingGuid}/contact/{contactGuid}

11.4.1. Parameters

Type Name Description Schema

Path

contactGuid
required

The contact you want to update.

string (guid)

Path

listingGuid
required

The listing you want to update.

string (guid)

Body

body
required

string

11.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingContactResponse

404

ErrorObject

422

ErrorObject

11.4.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

11.5. Get update form

GET /api/files/listings/{listingGuid}/contacts/{contactGuid}/updateListingContactForm

11.5.1. Parameters

Type Name Description Schema

Path

contactGuid
required

The contact you want to update.

string (guid)

Path

listingGuid
required

The listing you want to update.

string (guid)

11.5.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingContactForm

404

ErrorObject

422

ErrorObject

11.6. Add home warranty contact

POST /api/files/listings/{listingGuid}/homeWarrantyContact

11.6.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to add a contact to.

string (guid)

Body

form
required

The contact you want to add.

HomeWarrantyContactDTO

11.6.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddHomeWarrantyToListingResponse

404

ErrorObject

422

ErrorObject

11.6.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

11.7. Add home warranty contact

POST /api/files/listings/{listingGuid}/miscellaneousContact

11.7.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to add a contact to.

string (guid)

Body

form
required

The contact you want to add.

MiscellaneousContactDTO

11.7.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddMiscellaneousContactToListingResponse

404

ErrorObject

422

ErrorObject

11.7.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

11.8. Add seller contact

POST /api/files/listings/{listingGuid}/sellerContact

11.8.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to add a contact to.

string (guid)

Body

form
required

The contact you want to add.

SellerDTO

11.8.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddSellerToListingResponse

404

ErrorObject

422

ErrorObject

11.8.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

12. Listing Documents

Documents can be associated with a listing.

12.1. Update listing document

PATCH /api/files/listings/{listingGuid}/documents/{documentGuid}

12.1.1. Parameters

Type Name Schema

Path

documentGuid
required

string (guid)

Path

listingGuid
required

string (guid)

Body

form
required

PatchListingDocumentForm

12.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfPatchListingDocumentResponse

404

ErrorObject

422

ErrorObject

12.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

13. Listing Offices

A listing can belong to an office or the ALL office if not assigned to an office. The office determines which checklist types are available to it and which auditors can see it.

This endpoint is only for multi office brokers. Single office brokers do not need to call this and will get an error if they try to.

13.1. Update office

PUT /api/files/listings/{listingGuid}/office

13.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update

string (guid)

Body

form
required

UpdateListingOfficeForm

13.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingOfficeResponse

404

ErrorObject

422

ErrorObject

13.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

14. Listing Properties

Each listing has a property with the address and other data related to the physical property that is being listed.

Be sure to get the updateListingPropertyForm before updating since some fields can be configured to be required or not and that can change at any time.

14.1. Update property

PUT /api/files/listings/{listingGuid}/property

14.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

Body

form
required

UpdateListingPropertyForm

14.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingPropertyResponse

404

ErrorObject

422

ErrorObject

14.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

14.2. Get update form

GET /api/files/listings/{listingGuid}/updateListingPropertyForm

14.2.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

14.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateListingPropertyFormResponse

404

ErrorObject

422

ErrorObject

15. Listing Referring Agents

A listing can have one referring agent.

15.1. Get add form

GET /api/files/listings/{listingGuid}/addReferringAgentToListingForm

15.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to add referring agent to.

string (guid)

15.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddReferringAgentToListingFormResponse

404

ErrorObject

422

ErrorObject

15.2. Add referring agent

POST /api/files/listings/{listingGuid}/referringagent

15.2.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you wish to add the referringagent to.

string (guid)

Body

form
required

AddReferringAgentToListingForm

15.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddReferringAgentToListingResponse

404

ErrorObject

422

ErrorObject

15.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

15.3. Get referring agent

GET /api/files/listings/{listingGuid}/referringagent

15.3.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to get the referring agent of.

string (guid)

15.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetListingReferringAgentResponse

404

ErrorObject

422

ErrorObject

15.4. Update referring agent

PUT /api/files/listings/{listingGuid}/referringagent

15.4.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you wish to update the referringagent of.

string (guid)

Body

form
required

UpdateListingReferringAgentForm

15.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddReferringAgentToListingResponse

404

ErrorObject

422

ErrorObject

15.4.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

15.5. Get update form

GET /api/files/listings/{listingGuid}/updateListingReferringAgentForm

15.5.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update referring agent for.

string (guid)

15.5.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateListingReferringAgentFormResponse

404

ErrorObject

422

ErrorObject

16. Listing Stage

A listing can have a stage specified

16.1. Update listing stage

PATCH /api/listings/{listingGuid}/stage

16.1.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The sale you want to update.

string (guid)

Body

body
required

StagePatchRequest

16.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfStagePatchResponse

404

ErrorObject

422

ErrorObject

16.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

17. Listing Custom Fields

Custom fields for a listing.

17.1. Update custom fields

PUT /api/files/listings/{listingGuid}/customFields

17.1.1. Parameters

Type Name Schema

Path

listingGuid
required

string (guid)

Body

form
required

UpdateListingCustomFieldsForm

17.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingCustomFieldsResponse

404

ErrorObject

422

ErrorObject

17.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

18. Listings

A Listing represents a deal on the seller side, prior to entering contract with the buyer. Be sure to get the listingForm before creating a listing since some fields can be configured by SkySlope users to be required or not and that can change at any time.

When getting lists of Listings (see section "List all listings)", the results are returned 10 items at a time. By default, the first 10 items in the list are returned.

To progress through the pages of items, the PageNumber parameter can be added to the URL. For example, to get the third page of listings (items 21 through 30), use the following:

GET /api/files/listings?PageNumber=3

You can also find the link in the "links" section in the returned data of the request for the previous page. The "links" from PageNumber=2 are:

    "links": [
        {
            "href": "/api/files/listings?PageNumber=3",
            "rel": "next",
            "method": "GET"
        }
    ]

In addition to paging, filtering by date and agent is also possible.The optional parameters are:

  • earliestDate - The earliest date you want to search for expressed as unix time (seconds since 1970).

  • latestDate - The latest date you want to search for expressed as unix time(seconds since 1970).

  • agentGuid - Only return listings assigned to this agent.

  • createdByGuid - Only return listings created by this agent.

For example; if someone wanted all the listings created on or after March 1, 2019 assigned to an agent with a GUID of {AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}, the URL would be:

GET /api/files/listings?earliestDate=1551398400&agentGuid=AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE

In order to get the fourth page of listings created by an agent with a GUID of {11111111-2222-3333-4444-555555555555}, the URL would be:

GET /api/files/listings?PageNumber=4&agentGuid=11111111-2222-3333-4444-555555555555

18.1. Get create form

GET /api/files/listingForm

18.1.1. Parameters

Type Name Description Schema

Query

checklistTypeId
optional

The type of transaction you want to get checklist types for. The CheckListTypeID retrieved from the Checklists endpoint.

integer (int32)

Query

officeGuid
optional

The office you want to add a listing to.

string (guid)

18.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetListingFormResponse

404

ErrorObject

422

ErrorObject

18.2. Create listing

POST /api/files/listings

18.2.1. Parameters

Type Name Schema

Body

listingForm
required

ListingForm

18.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfCreateListingResponse

404

ErrorObject

422

ErrorObject

18.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

18.3. List all listings

GET /api/files/listings

18.3.1. Parameters

Type Name Description Schema

Query

agentGuid
optional

Only return listings assigned to this agent.

string (guid)

Query

createdByGuid
optional

Only return listings created by this agent.

string (guid)

Query

earliestDate
optional

The earliest date you want to search for expressed as unix time (seconds since 1970).

integer (int64)

Query

latestDate
optional

The latest date you want to search for expressed as unix time (seconds since 1970).

integer (int64)

Query

pageNumber
optional

Page number.

integer (int32)

18.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetListingsResponse

404

ErrorObject

422

ErrorObject

18.4. Get listing

GET /api/files/listings/{listingGuid}

18.4.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to get.

string (guid)

18.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetListingResponse

404

ErrorObject

422

ErrorObject

18.5. Update listing

PUT /api/files/listings/{listingGuid}

18.5.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The listing you want to update.

string (guid)

Body

form
required

UpdateListingsForm

18.5.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateListingResponse

404

ErrorObject

422

ErrorObject

18.5.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

18.6. Get update form

GET /api/files/listings/{listingGuid}/updateListingForm

18.6.1. Parameters

Type Name Description Schema

Path

listingGuid
required

The Listing you want to update.

string (guid)

18.6.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateListingFormResponse

404

ErrorObject

422

ErrorObject

19. Offices

Every listing or sale belongs to an office. Offices determine which checklist types can be used for a sale or listing.

Not all offices are available to all users. This only returns offices the given user has access to.

19.1. List offices

GET /api/offices

19.1.1. Responses

HTTP Code Schema

200

LinkedResponseOfGetOfficesResponse

404

ErrorObject

422

ErrorObject

19.2. Gets office by officeGuid

GET /api/offices/{officeGuid}

19.2.1. Parameters

Type Name Schema

Path

officeGuid
required

string (guid)

19.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetOfficeResponse

404

ErrorObject

422

ErrorObject

19.3. Update an office

PATCH /api/offices/{officeGuid}

19.3.1. Parameters

Type Name Schema

Path

officeGuid
required

string (guid)

Body

form
required

PatchOfficeForm

19.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetOfficesResponse

404

ErrorObject

422

ErrorObject

19.3.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

20. Sale Additional Commissions Information Log

A sale can have additional commission information data associated to it.

20.1. Add to log

POST /api/files/sales/{saleGuid}/commissionLog

20.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

The form with additional commission information log you want to add.

AddAdditionalCommissionInformationLogToSaleForm

20.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddAdditionalCommissionInformationLogToSaleResponse

404

ErrorObject

422

ErrorObject

20.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

20.2. Get commission log

GET /api/files/sales/{saleGuid}/commissionLog

20.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to get additional commission information log.

string (guid)

20.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAdditionalCommissionInformationLogToSaleResponse

404

ErrorObject

422

ErrorObject

21. Sale Agents

Each sale has one and only one primary agent assigned to it. If you want to assign co agents, look at Sale Co Agents.

21.1. Update agent

PUT /api/files/sales/{saleGuid}/agent

21.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

UpdateSaleAgentForm

21.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleAgentResponse

404

ErrorObject

422

ErrorObject

21.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

22. Sale Checklist Types

A sale must have one checklist type. The checklist type determines which fields are available. The sale’s office determines which checklist types are available.

You can not update a sale with a "Commercial Lease" checklist type to have a non-"Commercial Lease" checklist type or the other way around.

See Checklists for more info on checklists.

22.1. Update checklist type

PUT /api/files/sales/{saleGuid}/checklistType

22.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

UpdateSaleChecklistTypeForm

22.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateChecklistTypeResponse

404

ErrorObject

422

ErrorObject

22.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

23. Sale Co Agents

A sale can have from zero up to 5 co agents assigned. If you want to update the primary agent assigned, see Sale Agents.

23.1. Update co agents

PUT /api/files/sales/{saleGuid}/coAgents

23.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

UpdateSaleCoAgentsForm

23.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleCoAgentsResponse

404

ErrorObject

422

ErrorObject

23.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

23.2. Get update form

GET /api/files/sales/{saleGuid}/updateSaleCoAgentsForm

23.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

23.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateSaleCoAgentsFormResponse

404

ErrorObject

422

ErrorObject

24. Sale Commission Breakdowns

Sale Commission Breakdowns describe how the commissions on a Sale are broken down. This may include payments to 3rd parties such as Transaction Coordinators, consultants, or other personnel.

See the form for details on the available fields.

24.1. Update commission breakdown

PUT /api/files/sales/{saleGuid}/commissionBreakdown

24.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

UpdateSaleCommissionBreakdownForm

24.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleCommissionBreakdownResponse

404

ErrorObject

422

ErrorObject

24.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

24.2. Get update form

GET /api/files/sales/{saleGuid}/updateCommissionBreakdownsForm

24.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

24.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateSaleCommissionBreakdownsFormResponse

404

ErrorObject

422

ErrorObject

25. Sale Commission Referral

A sale can have commission referral data associated to it.

Be sure to get the commissionReferralForm before adding or patching commission referral data since some fields can be configured to be required or not and that can change at any time.

25.1. Add commission referral

POST /api/files/sales/{saleGuid}/commissionReferral

25.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to add a commission referral to.

string (guid)

Body

form
required

The form with commission referral data you want to add.

AddCommissionReferralToSaleForm

25.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddCommissionReferralToSale

404

ErrorObject

422

ErrorObject

25.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

25.2. Update commission referral

PATCH /api/files/sales/{saleGuid}/commissionReferral

25.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

The form with commission referral data you want to update.

PatchSaleCommissionReferralForm

25.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddCommissionReferralToSale

404

ErrorObject

422

ErrorObject

25.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

25.3. Get form

GET /api/files/sales/{saleGuid}/commissionReferralForm

25.3.1. Parameters

Type Name Schema

Path

saleGuid
required

string (guid)

25.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetSaleCommissionReferralFormResponse

404

ErrorObject

422

ErrorObject

26. Sale Commission Splits

Sale Commission Splits describe how the Sales Commission is broken down between the primary Agent on the Sale and the Co-Agents on the sale.

26.1. Update commission split

PUT /api/files/sales/{saleGuid}/commissionSplit

26.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update commission split for.

string (guid)

Body

form
required

UpdateSaleCommissionSplitForm

26.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleCommissionSplitResponse

404

ErrorObject

422

ErrorObject

26.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

26.2. Get update form

GET /api/files/sales/{saleGuid}/updateCommissionSplitForm

26.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

26.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateSaleCommissionSplitFormResponse

404

ErrorObject

422

ErrorObject

27. Sale Commissions

A sale can have commission data associated to it.

Be sure to get the addCommissionsToSaleForm before adding and the updateSaleCommissionsForm before updating commission data since some fields can be configured to be required or not and that can change at any time.

27.1. Get add form

GET /api/files/sales/{saleGuid}/addCommissionsToSaleForm

27.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

27.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddCommissionsToSaleFormResponse

404

ErrorObject

422

ErrorObject

27.2. Add commissions

POST /api/files/sales/{saleGuid}/commissions

27.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to add commissions to.

string (guid)

Body

form
required

AddCommissionsToSaleForm

27.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleCommissionsResponse

404

ErrorObject

422

ErrorObject

27.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

27.3. Update commissions

PUT /api/files/sales/{saleGuid}/commissions

27.3.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

UpdateSaleCommissionsForm

27.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleCommissionsResponse

404

ErrorObject

422

ErrorObject

27.3.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

27.4. Get update form

GET /api/files/sales/{saleGuid}/updateSaleCommissionsForm

27.4.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

27.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateSaleCommissionsFormResponse

404

ErrorObject

422

ErrorObject

28. Sale Contacts

A sale can have several different contacts associated with it.

Be sure to get the updateSaleContactForm before updating a contact since some fields can be configured to be required or not and that can change at any time.

28.1. Get add form

GET /api/files/sales/{saleGuid}/addAttorneyContactToSaleForm

28.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddAttorneyContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.2. Get add form

GET /api/files/sales/{saleGuid}/addBuyerContactToSaleForm

28.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddBuyerContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.3. Get add form

GET /api/files/sales/{saleGuid}/addEscrowContactToSaleForm

28.3.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddEscrowContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.4. Get add form

GET /api/files/sales/{saleGuid}/addHomeWarrantyContactToSaleForm

28.4.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddHomeWarrantyContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.5. Get add form

GET /api/files/sales/{saleGuid}/addLenderContactToSaleForm

28.5.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.5.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddLenderContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.6. Get add form

GET /api/files/sales/{saleGuid}/addMiscellaneousContactToSaleForm

28.6.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.6.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddMiscellaneousContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.7. Get add form

GET /api/files/sales/{saleGuid}/addOtherSideAgentContactToSaleForm

28.7.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.7.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddOtherSideAgentContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.8. Get add form

GET /api/files/sales/{saleGuid}/addSellerContactToSaleForm

28.8.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.8.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddSellerContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.9. Get add form

GET /api/files/sales/{saleGuid}/addTitleContactToSaleForm

28.9.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

28.9.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddTitleContactToSaleFormResponse

404

ErrorObject

422

ErrorObject

28.10. Add attorney contact

POST /api/files/sales/{saleGuid}/attorneyContact

28.10.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.10.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddAttorneyContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.10.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.11. Add buyer contact

POST /api/files/sales/{saleGuid}/buyerContact

28.11.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.11.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddBuyerContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.11.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.12. Update contact

PUT /api/files/sales/{saleGuid}/contacts/{contactGuid}

28.12.1. Parameters

Type Name Description Schema

Path

contactGuid
required

The contact you want to update.

string (guid)

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

body
required

string

28.12.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleContactResponse

404

ErrorObject

422

ErrorObject

28.12.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.13. Get update form

GET /api/files/sales/{saleGuid}/contacts/{contactGuid}/updateSaleContactForm

28.13.1. Parameters

Type Name Description Schema

Path

contactGuid
required

The contact you want to update.

string (guid)

Path

saleGuid
required

The sale you want to update.

string (guid)

28.13.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateSaleContactFormResponse

404

ErrorObject

422

ErrorObject

28.14. Add escrow contact

POST /api/files/sales/{saleGuid}/escrowContact

28.14.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.14.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddEscrowContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.14.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.15. Add home warranty contact

POST /api/files/sales/{saleGuid}/homeWarrantyContact

28.15.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.15.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddHomeWarrantyContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.15.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.16. Add lender contact

POST /api/files/sales/{saleGuid}/lenderContact

28.16.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.16.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddLenderContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.16.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.17. Add miscellaneous contact

POST /api/files/sales/{saleGuid}/miscellaneousContact

28.17.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.17.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddMiscellaneousContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.17.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.18. Add other side agent contact

POST /api/files/sales/{saleGuid}/otherSideAgentContact

28.18.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.18.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddOtherSideAgentContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.18.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.19. Add seller contact

POST /api/files/sales/{saleGuid}/sellerContact

28.19.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.19.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddSellerContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.19.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

28.20. Add title contact

POST /api/files/sales/{saleGuid}/titleContact

28.20.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

string

28.20.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddTitleContactToSaleResponse

404

ErrorObject

422

ErrorObject

28.20.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

29. Sale Offices

A sale can belong to an office or the ALL office if not assigned to an office. The office determines which checklist types are available to it and which auditors can see it.

This endpoint is only for multi office brokers. Single office brokers do not need to call this and will get an error if they try to.

29.1. Update office

PUT /api/files/sales/{saleGuid}/office

29.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

UpdateSaleOfficeForm

29.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleOfficeResponse

404

ErrorObject

422

ErrorObject

29.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

30. Sale Properties

Each sale has a property with the address and other data related to the physical property that is being listed.

Be sure to get the updateSalePropertyForm before updating since some fields can be configured to be required or not and that can change at any time.

30.1. Update property

PUT /api/files/sales/{saleGuid}/property

30.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

UpdateSalePropertyForm

30.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSalePropertyResponse

404

ErrorObject

422

ErrorObject

30.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

30.2. Get update form

GET /api/files/sales/{saleGuid}/updateSalePropertyForm

30.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

30.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateSalePropertyFormResponse

404

ErrorObject

422

ErrorObject

31. Sale Referring Agents

A Sale can have one referring agent.

31.1. Get add form

GET /api/files/sales/{saleGuid}/addReferringAgentToSaleForm

31.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to add referring agent to.

string (guid)

31.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddReferringAgentToSaleFormResponse

404

ErrorObject

422

ErrorObject

31.2. Add referring agent

POST /api/files/sales/{saleGuid}/referringagent

31.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to add the referringagent to.

string (guid)

Body

form
required

AddReferringAgentToSaleForm

31.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddReferringAgentToSaleResponse

404

ErrorObject

422

ErrorObject

31.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

31.3. Get referring agent

GET /api/files/sales/{saleGuid}/referringagent

31.3.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to get the referring agent of.

string (guid)

31.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddReferringAgentToSaleResponse

404

ErrorObject

422

ErrorObject

31.4. Update referring agent

PUT /api/files/sales/{saleGuid}/referringagent

31.4.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update the referring agent of.

string (guid)

Body

form
required

UpdateSaleReferringAgentForm

31.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddReferringAgentToSaleResponse

404

ErrorObject

422

ErrorObject

31.4.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

31.5. Get update form

GET /api/files/sales/{saleGuid}/updateSaleReferringAgentForm

31.5.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update referring agent for.

string (guid)

31.5.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateSaleReferringAgentFormResponse

404

ErrorObject

422

ErrorObject

32. Sale Stage

A sale can have a stage specified

32.1. Update sale stage

PATCH /api/sales/{saleGuid}/stage

32.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

body
required

StagePatchRequest2

32.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfStagePatchResponse

404

ErrorObject

422

ErrorObject

32.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

33. Sale Custom Fields

Custom fields for a sale.

33.1. Update custom fields

PUT /api/files/sales/{saleGuid}/customFields

33.1.1. Parameters

Type Name Schema

Path

saleGuid
required

string (guid)

Body

form
required

UpdateSaleCustomFieldsForm

33.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleCustomFieldsResponse

404

ErrorObject

422

ErrorObject

33.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

34. Sale Documents

A Sale can have documents associated to it.

34.1. Get add form

GET /api/files/sales/{saleGuid}/addDocumentsToSaleForm

34.1.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to add the document to.

string (guid)

34.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetAddDocumentoToSaleFormResponse

404

ErrorObject

422

ErrorObject

34.2. Add document

POST /api/files/sales/{saleGuid}/documents

34.2.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to add the document to.

string (guid)

Body

form
required

AddDocumentToSaleForm

34.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddDocumentToSaleResponse

404

ErrorObject

422

ErrorObject

34.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

34.3. Update document

PATCH /api/files/sales/{saleGuid}/documents/{documentGuid}

34.3.1. Parameters

Type Name Description Schema

Path

documentGuid
required

The document metadata you want to make changes the document to.

string (guid)

Path

saleGuid
required

The sale you want to update the document for.

string (guid)

Body

form
required

PatchSaleDocumentForm

34.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfAddDocumentToSaleResponse

404

ErrorObject

422

ErrorObject

34.3.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

35. Sales

A Sale represents a deal that is under contract. A Sale may represent either Buyer or Seller side transactions. Be sure to get the saleForm before creating a sale since some fields can be configured to be required or not and that can change at any time.

When getting lists of Sales (see section "List sales"), the results are returned 10 items at a time. By default, the first 10 items in the list are returned.

To progress through the pages of items, the PageNumber parameter can be added to the URL. For example, to get the third page of sales (items 21 through 30), use the following:

GET /api/files/sales?PageNumber=3

You can also find the link in the "links" section in the returned data of the request for the previous page. The "links" from PageNumber=2 are:

    "links": [
        {
            "href": "/api/files/sales?PageNumber=3",
            "rel": "next",
            "method": "GET"
        }
    ]

In addition to paging, filtering by date and agent is also possible.The optional parameters are:

  • earliestDate - The earliest date you want to search for expressed as unix time (seconds since 1970).

  • latestDate - The latest date you want to search for expressed as unix time(seconds since 1970).

  • agentGuid - Only return sales assigned to this agent.

  • createdByGuid - Only return sales created by this agent.

For example; if someone wanted all the sales created on or after March 1, 2019 assigned to an agent with a GUID of {AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}, the URL would be:

GET /api/files/sales?earliestDate=1551398400&agentGuid=AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE

In order to get the fourth page of sales created by an agent with a GUID of {11111111-2222-3333-4444-555555555555}, the URL would be:

GET /api/files/sales?PageNumber=4&agentGuid=11111111-2222-3333-4444-555555555555

35.1. Get create form

GET /api/files/saleForm

35.1.1. Parameters

Type Name Description Schema

Query

checklistTypeId
optional

The type of transaction you want to get checklist types for. The CheckListTypeID retrieved from the Checklists endpoint.

integer (int32)

Query

officeGuid
optional

The office you want to add a listing to.

string (guid)

35.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetSaleFormResponse

404

ErrorObject

422

ErrorObject

35.2. Add sale

POST /api/files/sales

35.2.1. Parameters

Type Name Schema

Body

saleForm
required

SaleForm

35.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfCreateSaleResponse

404

ErrorObject

422

ErrorObject

35.2.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

35.3. List sales

GET /api/files/sales

35.3.1. Parameters

Type Name Description Schema

Query

agentGuid
optional

Only return listings assigned to this agent.

string (guid)

Query

createdByGuid
optional

Only return listings created by this agent.

string (guid)

Query

earliestDate
optional

The earliest date you want to search for expressed as unix time (seconds since 1970).

integer (int64)

Query

latestDate
optional

The latest date you want to search for expressed as unix time (seconds since 1970).

integer (int64)

Query

pageNumber
optional

Page number.

integer (int32)

35.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetSalesResponse

404

ErrorObject

422

ErrorObject

35.4. Get sale

GET /api/files/sales/{saleGuid}

35.4.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to get.

string (guid)

35.4.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetSaleResponse

404

ErrorObject

422

ErrorObject

35.5. Update sale

PUT /api/files/sales/{saleGuid}

35.5.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

Body

form
required

UpdateSaleForm

35.5.2. Responses

HTTP Code Schema

200

LinkedResponseOfUpdateSaleResponse

404

ErrorObject

422

ErrorObject

35.5.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

35.6. Get update form

GET /api/files/sales/{saleGuid}/updateSaleForm

35.6.1. Parameters

Type Name Description Schema

Path

saleGuid
required

The sale you want to update.

string (guid)

35.6.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUpdateSaleFormResponse

404

ErrorObject

422

ErrorObject

36. Stages

Stage determines the phase of sale or a listing

36.1. Create a stage

POST /api/stages

36.1.1. Parameters

Type Name Schema

Body

payload
required

CreateStageRequest

36.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfCreateStageResponse

404

ErrorObject

422

ErrorObject

36.1.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

36.2. List stages

GET /api/stages

36.2.1. Responses

HTTP Code Schema

200

LinkedResponseOfGetStagesResponse

404

ErrorObject

422

ErrorObject

36.3. Updates a stage

PATCH /api/stages

36.3.1. Parameters

Type Name Schema

Body

payload
required

StageChanges

36.3.2. Responses

HTTP Code Schema

200

LinkedResponseOfPatchStageResponse

404

ErrorObject

422

ErrorObject

36.3.3. Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

37. Subscriber Resources

Subscriber resources include the users and transaction types that are available to a broker.

This endpoint is deprecated. Please use the list users endpoint to get users.

37.1. Get subscriber resources

GET /api/subscribers

37.1.1. Parameters

Type Name Description Schema Default

Query

showAll
optional

Show deactivated users.

boolean

"true"

37.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetSubscriberResponse

404

ErrorObject

422

ErrorObject

38. Users

Users are anyone who can log in and do things. Users can be an Agent, Auditor, Broker, or Limited TC.

38.1. List users

GET /api/users

38.1.1. Parameters

Type Name Description Schema

Query

includeDeactivated
optional

Include deactivated users. Defaults to false.

boolean

Query

officeGuid
optional

Only return users who have access to this office. Use an empty guid (00000000-0000-0000-0000-000000000000) for the ALL office.

string (guid)

38.1.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUsersResponse

404

ErrorObject

422

ErrorObject

38.2. Get a single user object

GET /api/users/{userGuid}

38.2.1. Parameters

Type Name Description Schema

Path

userGuid
required

The user you want to get.

string (guid)

38.2.2. Responses

HTTP Code Schema

200

LinkedResponseOfGetUsersResponse

404

ErrorObject

422

ErrorObject

39. Definitions

39.1. AddAdditionalCommissionInformationLogToSaleForm

Name Schema

comment
optional

string

39.2. AddAdditionalCommissionInformationLogToSaleResponse

Name Schema

saleGuid
required

string (guid)

39.3. AddAttorneyContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.4. AddBuyerContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.5. AddCommissionReferralToListing

Name Schema

form
optional

AddCommissionReferralToListingForm

listingGuid
required

string (guid)

subscriberGuid
required

string (guid)

userGuid
required

string (guid)

39.6. AddCommissionReferralToListingForm

Name Schema

amount
optional

number (decimal)

brokerName
optional

string

contact
optional

CommissionReferralContactForm

percent
optional

number (decimal)

39.7. AddCommissionReferralToSale

Name Schema

form
optional

AddCommissionReferralToSaleForm

saleGuid
required

string (guid)

subscriberGuid
required

string (guid)

userGuid
required

string (guid)

39.8. AddCommissionReferralToSaleForm

Name Schema

amount
optional

number (decimal)

brokerName
optional

string

contact
optional

CommissionReferralContactForm2

percent
optional

number (decimal)

typeId
optional

integer (int32)

39.9. AddCommissionToListingForm

Name Description Schema

commissionBreakdown
optional

string

listingCommissionAmount
optional

If required, either percent or amount field needs to be filled

number (decimal)

listingCommissionPercent
optional

If required, either percent or amount field needs to be filled

number (decimal)

officeGrossCommission
optional

number (decimal)

referralAmount
optional

number (decimal)

referralAmountPercent
optional

number (decimal)

saleCommissionPercent
optional

If required, either percent or amount field needs to be filled

number (decimal)

salesCommissionAmount
optional

If required, either percent or amount field needs to be filled

number (decimal)

transCoordinatorFee
optional

number (decimal)

39.10. AddCommissionToListingResponse

Name Schema

listingGuid
required

string (guid)

39.11. AddCommissionsToSaleForm

Name Description Schema

commissionBreakdownDetails
optional

string

dateOfCheck
optional

string (date-time)

datePostedToLogBook
optional

string (date-time)

listingCommissionAmount
optional

If required, either percent or amount field needs to be filled

number (decimal)

listingCommissionPercent
optional

If required, either percent or amount field needs to be filled

number (decimal)

otherDeductions
optional

number (decimal)

personalDeal
optional

boolean

saleCommissionAmount
optional

If required, either percent or amount field needs to be filled

number (decimal)

saleCommissionPercent
optional

If required, either percent or amount field needs to be filled

number (decimal)

transactionCoordinatorFee
optional

number (decimal)

transactionCoordinatorName
optional

string

39.12. AddDocumentToSaleForm

Name Description Schema

base64Content
required

The PDF as base64 encoded.
Minimum length : 1

string

fileName
required

The filename of the pdf, it must include the .pdf extension.
Minimum length : 1

string

39.13. AddDocumentToSaleResponse

Name Schema

documentGuid
required

string (guid)

documentName
optional

string

saleGuid
required

string (guid)

39.14. AddEnvelopePayload

Name Schema

listingGuid
optional

string (guid)

saleGuid
optional

string (guid)

39.15. AddEscrowContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.16. AddHomeWarrantyContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.17. AddHomeWarrantyToListingResponse

Name Schema

contactGuid
required

string (guid)

listingGuid
required

string (guid)

39.18. AddLenderContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.19. AddMiscellaneousContactToListingResponse

Name Schema

contactGuid
required

string (guid)

listingGuid
required

string (guid)

39.20. AddMiscellaneousContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.21. AddOtherSideAgentContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.22. AddReferringAgentToListingForm

Name Description Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
required

Minimum length : 1

string

lastName
required

Minimum length : 1

string

phoneNumber
optional

string

publicID
optional

string

state
optional

string

streetAddress
optional

string

streetNumber
optional

string

zip
optional

string

39.23. AddReferringAgentToListingResponse

Name Schema

contactGuid
required

string (guid)

listingGuid
required

string (guid)

39.24. AddReferringAgentToSaleForm

Name Description Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
required

Minimum length : 1

string

lastName
required

Minimum length : 1

string

phoneNumber
optional

string

publicID
optional

string

state
optional

string

streetAddress
optional

string

streetNumber
optional

string

zip
optional

string

39.25. AddReferringAgentToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.26. AddSellerContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.27. AddSellerToListingResponse

Name Schema

contactGuid
required

string (guid)

listingGuid
required

string (guid)

39.28. AddTitleContactToSaleResponse

Name Schema

contactGuid
required

string (guid)

saleGuid
required

string (guid)

39.29. AdditionalCommissionInformation

Name Schema

comment
optional

string

timestamp
optional

string (date-time)

userGuid
optional

string (guid)

39.30. AttorneyContactDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

lastName
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.31. BuyerDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

isTrustCompanyOrOtherEntity
required

boolean

lastName
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.32. ChecklistTypeDTO

Name Schema

checklistTypeId
required

integer (int32)

checklistTypeName
optional

string

39.33. ChecklistTypeDTO2

Name Schema

checklistTypeId
required

integer (int32)

checklistTypeName
optional

string

39.34. CommercialLeaseDTO

Name Schema

size
optional

number (decimal)

sizeType
optional

string

39.35. CommercialLeaseDTO2

Name Schema

size
optional

number (decimal)

sizeType
optional

string

39.36. CommercialLeaseDTO3

Name Schema

size
optional

number (decimal)

sizeType
optional

string

39.37. CommercialLeaseDTO4

Name Schema

commencementDate
optional

string (date-time)

endingDate
optional

string (date-time)

purchaseOption
optional

boolean

renewalOption
optional

boolean

size
optional

number (decimal)

sizeType
optional

string

39.38. CommercialLeaseDTO5

Name Schema

commencementDate
optional

string (date-time)

endingDate
optional

string (date-time)

purchaseOption
optional

boolean

renewalOption
optional

boolean

size
optional

number (decimal)

sizeType
optional

string

39.39. CommercialLeaseDTO6

Name Schema

commencementDate
optional

string (date-time)

endingDate
optional

string (date-time)

purchaseOption
optional

boolean

renewalOption
optional

boolean

size
optional

number (decimal)

sizeType
optional

string

39.40. CommissionBreakdownDTO

Name Schema

amount
optional

number (decimal)

details
optional

string

name
optional

string

39.41. CommissionBreakdownDTO2

Name Schema

amount
required

number (decimal)

details
optional

string

name
optional

string

39.42. CommissionDTO

Name Schema

commissionBreakdown
optional

string

listingCommissionAmount
optional

number (decimal)

listingCommissionPercent
optional

number (decimal)

officeGrossCommission
optional

number (decimal)

referralAmount
optional

number (decimal)

referralAmountPercent
optional

number (decimal)

saleCommissionPercent
optional

number (decimal)

salesCommissionAmount
optional

number (decimal)

transCoordinatorFee
optional

number (decimal)

39.43. CommissionDTO2

Name Schema

commissionBreakdownDetails
optional

string

dateOfCheck
optional

string (date-time)

datePostedToLogBook
optional

string (date-time)

listingCommissionAmount
optional

number (decimal)

listingCommissionPercent
optional

number (decimal)

officeGrossCommissionOnSale
optional

number (decimal)

otherDeductions
optional

number (decimal)

personalDeal
optional

boolean

saleCommissionAmount
optional

number (decimal)

saleCommissionPercent
optional

number (decimal)

transactionCoordinatorFee
optional

number (decimal)

transactionCoordinatorName
optional

string

39.44. CommissionReferral

Name Schema

amount
optional

number (decimal)

brokerageName
optional

string

contact
optional

CommissionReferralContact

percent
optional

number (decimal)

39.45. CommissionReferral2

Name Schema

amount
optional

number (decimal)

brokerageName
optional

string

contact
optional

CommissionReferralContact2

percent
optional

number (decimal)

type
optional

CommissionReferralType

39.46. CommissionReferralContact

Name Schema

email
optional

string

firstName
optional

string

guid
required

string (guid)

lastName
optional

string

phoneNumber
optional

string

39.47. CommissionReferralContact2

Name Schema

email
optional

string

firstName
optional

string

guid
required

string (guid)

lastName
optional

string

phoneNumber
optional

string

39.48. CommissionReferralContactForm

Name Schema

email
optional

string

firstName
optional

string

lastName
optional

string

phoneNumber
optional

string

39.49. CommissionReferralContactForm2

Name Schema

email
optional

string

firstName
optional

string

lastName
optional

string

phoneNumber
optional

string

39.50. CommissionReferralType

Name Schema

id
required

integer (int32)

name
optional

string

39.51. CommissionSplit

Name Schema

agentGuid
optional

string (guid)

amount
optional

number (decimal)

percentage
optional

number (decimal)

39.52. CommissionSplitsDTO

Name Schema

agentGuid
required

string (guid)

amount
optional

number (decimal)

percentage
optional

number (decimal)

39.53. ContactDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
optional

string

id
required

string (guid)

isCompany
required

boolean

isShared
required

boolean

lastName
optional

string

phone
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.54. CreateDirectoryContactResponse

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

isCompany
required

boolean

isShared
required

boolean

lastName
optional

string

phone
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.55. CreateListingCustomFieldsDTO

Name Schema

comingSoon
optional

string

conciergeProjectNumber
optional

string

isConcierge
optional

string

listingId
optional

string

serviceType
optional

string

39.56. CreateListingResponse

Name Schema

listingGuid
required

string (guid)

39.57. CreateSaleCustomFieldsDTO

Name Schema

conciergeProjectNumber
optional

string

isConcierge
optional

string

serviceType
optional

string

39.58. CreateSaleResponse

Name Schema

saleGuid
required

string (guid)

39.59. CreateStageRequest

Name Schema

name
optional

string

39.60. CreateStageResponse

Name Schema

id
required

integer (int32)

39.61. DirectoryContactForm

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
optional

string

isCompany
optional

boolean

isShared
optional

boolean

lastName
optional

string

phone
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.62. DirectoryContactForm2

Name Description Schema

alternatePhone
optional

string (phone)

city
optional

Maximal length : 50

string

company
optional

Maximal length : 200

string

email
required

Length : 1 - 100

string (email)

fax
optional

string (phone)

firstName
required

Length : 1 - 100

string

isCompany
optional

boolean

isShared
optional

Only broker users can share their contacts with other users

boolean

lastName
required

Length : 1 - 100

string

phone
optional

string (phone)

state
optional

Maximal length : 50

string

streetName
optional

Maximal length : 200

string

streetNumber
optional

Maximal length : 100

string

zip
optional

Maximal length : 5

string

39.63. DocumentUploadPayload

Name Schema

bypassMetadata
optional

boolean

collectStats
optional

boolean

fileName
optional

string

forms
optional

FormsDocumentAssociation

sourceBucket
optional

string

sourceKey
optional

string

url
optional

string

39.64. EarnestMoneyDepositDTO

Name Schema

additionalDepositAmount
optional

number (decimal)

additionalDepositDueDate
optional

string (date-time)

dateOfCheck
optional

string (date-time)

datePostedToLogBook
optional

string (date-time)

depositAmount
optional

number (decimal)

depositDueDate
optional

string (date-time)

isEarnestMoneyHeld
optional

boolean

39.65. ErrorObject

Name Schema

errors
optional

< string > array

39.66. EscrowContactDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

lastName
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.67. Field

Name Schema

allowableSelections
optional

< object > array

deprecated
required

boolean

deprecatedAsOf
optional

string

deprecatedAvailableSelections
required

boolean

deprecatedAvailableSelectionsAsOf
optional

string

description
optional

string

fieldName
optional

string

fieldType
optional

string

isRequired
required

boolean

subFields
optional

< Field > array

39.68. FormsDocumentAssociation

Name Schema

documentId
required

integer (int32)

id
required

integer (int32)

39.69. GetAddAttorneyContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.70. GetAddBuyerContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.71. GetAddCommissionToListingFormResponse

Name Schema

fields
optional

< Field > array

39.72. GetAddCommissionsToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.73. GetAddDocumentoToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.74. GetAddEscrowContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.75. GetAddHomeWarrantyContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.76. GetAddHomeWarrantyToListingFormResponse

Name Schema

fields
optional

< Field > array

39.77. GetAddLenderContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.78. GetAddMiscellaneousContactToListingFormResponse

Name Schema

fields
optional

< Field > array

39.79. GetAddMiscellaneousContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.80. GetAddOtherSideAgentContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.81. GetAddReferringAgentToListingFormResponse

Name Schema

fields
optional

< Field > array

39.82. GetAddReferringAgentToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.83. GetAddSellerContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.84. GetAddSellerToListingFormResponse

Name Schema

fields
optional

< Field > array

39.85. GetAddTitleContactToSaleFormResponse

Name Schema

fields
optional

< Field > array

39.86. GetAdditionalCommissionInformationLogToSaleResponse

Name Schema

additionalCommissionInformationLog
optional

< AdditionalCommissionInformation > array

39.87. GetBulkExportResponse

Name Schema

bulkExport
optional

IBulkExport

39.88. GetChecklistTypesResponse

Name Schema

checklistTypes
optional

< ChecklistTypeDTO > array

39.89. GetChecklistTypesResponse2

Name Schema

checklistTypes
optional

< ChecklistTypeDTO2 > array

39.90. GetContactsResponse

Name Schema

contacts
optional

< ContactDTO > array

39.91. GetListingCommissionReferralFormResponse

Name Schema

fields
optional

< Field > array

39.92. GetListingFormResponse

Name Schema

fields
optional

< Field > array

39.93. GetListingReferringAgentResponse

Name Schema

listingReferringAgent
optional

ListingReferringAgentDTO

39.94. GetListingResponse

Name Schema

listing
optional

ListingDTO

39.95. GetListingsResponse

Name Schema

listings
optional

< ListingsDTO > array

39.96. GetOfficeResponse

Name Schema

office
optional

OfficeDTO

39.97. GetOfficesResponse

Name Schema

offices
optional

< OfficesDTO > array

39.98. GetSaleCommissionReferralFormResponse

Name Schema

fields
optional

< Field > array

39.99. GetSaleFormResponse

Name Schema

fields
optional

< Field > array

39.100. GetSaleResponse

Name Schema

sale
optional

SaleDTO

39.101. GetSalesResponse

Name Schema

sales
optional

< SalesDTO > array

39.102. GetStagesResponse

Name Schema

stages
optional

< StageDTO3 > array

39.103. GetSubscriberResponse

Name Schema

isMultiOffice
required

boolean

transactionTypes
optional

< string > array

users
optional

< UserDTO > array

39.104. GetUpdateListingCoAgentsFormResponse

Name Schema

fields
optional

< Field > array

39.105. GetUpdateListingCommissionsFormResponse

Name Schema

fields
optional

< Field > array

39.106. GetUpdateListingFormResponse

Name Schema

fields
optional

< Field > array

39.107. GetUpdateListingPropertyFormResponse

Name Schema

fields
optional

< Field > array

39.108. GetUpdateListingReferringAgentFormResponse

Name Schema

fields
optional

< Field > array

39.109. GetUpdateSaleCoAgentsFormResponse

Name Schema

fields
optional

< Field > array

39.110. GetUpdateSaleCommissionBreakdownsFormResponse

Name Schema

fields
optional

< Field > array

39.111. GetUpdateSaleCommissionSplitFormResponse

Name Schema

fields
optional

< Field > array

39.112. GetUpdateSaleCommissionsFormResponse

Name Schema

fields
optional

< Field > array

39.113. GetUpdateSaleContactFormResponse

Name Schema

fields
optional

< Field > array

39.114. GetUpdateSaleFormResponse

Name Schema

fields
optional

< Field > array

39.115. GetUpdateSalePropertyFormResponse

Name Schema

fields
optional

< Field > array

39.116. GetUpdateSaleReferringAgentFormResponse

Name Schema

fields
optional

< Field > array

39.117. GetUsersResponse

Name Schema

users
optional

< UserDTO2 > array

39.118. HomeWarrantyContactDTO

Name Schema

company
optional

string

confirmationNumber
optional

string

notes
optional

string

phoneNumber
optional

string

representativeName
optional

string

39.119. HomeWarrantyContactDTO2

Name Schema

company
optional

string

confirmationNumber
optional

string

contactGuid
required

string (guid)

notes
optional

string

phoneNumber
optional

string

representativeName
optional

string

39.120. HomeWarrantyContactDTO3

Name Schema

company
optional

string

confirmationNumber
optional

string

contactGuid
required

string (guid)

notes
optional

string

phoneNumber
optional

string

representativeName
optional

string

39.121. IBulkExport

Type : object

39.122. LenderContactDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

isCashDeal
required

boolean

lastName
optional

string

loanAmount
optional

number (decimal)

loanType
optional

string

loanTypeId
optional

integer (int32)

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.123. Link

Name Schema

href
optional

string

method
optional

string

rel
optional

string

39.124. LinkedResponseOfAddAdditionalCommissionInformationLogToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddAdditionalCommissionInformationLogToSaleResponse

warnings
optional

< string > array

39.125. LinkedResponseOfAddAttorneyContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddAttorneyContactToSaleResponse

warnings
optional

< string > array

39.126. LinkedResponseOfAddBuyerContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddBuyerContactToSaleResponse

warnings
optional

< string > array

39.127. LinkedResponseOfAddCommissionReferralToListing

Name Schema

links
optional

< Link > array

value
optional

AddCommissionReferralToListing

warnings
optional

< string > array

39.128. LinkedResponseOfAddCommissionReferralToSale

Name Schema

links
optional

< Link > array

value
optional

AddCommissionReferralToSale

warnings
optional

< string > array

39.129. LinkedResponseOfAddCommissionToListingResponse

Name Schema

links
optional

< Link > array

value
optional

AddCommissionToListingResponse

warnings
optional

< string > array

39.130. LinkedResponseOfAddDocumentToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddDocumentToSaleResponse

warnings
optional

< string > array

39.131. LinkedResponseOfAddEscrowContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddEscrowContactToSaleResponse

warnings
optional

< string > array

39.132. LinkedResponseOfAddHomeWarrantyContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddHomeWarrantyContactToSaleResponse

warnings
optional

< string > array

39.133. LinkedResponseOfAddHomeWarrantyToListingResponse

Name Schema

links
optional

< Link > array

value
optional

AddHomeWarrantyToListingResponse

warnings
optional

< string > array

39.134. LinkedResponseOfAddLenderContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddLenderContactToSaleResponse

warnings
optional

< string > array

39.135. LinkedResponseOfAddMiscellaneousContactToListingResponse

Name Schema

links
optional

< Link > array

value
optional

AddMiscellaneousContactToListingResponse

warnings
optional

< string > array

39.136. LinkedResponseOfAddMiscellaneousContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddMiscellaneousContactToSaleResponse

warnings
optional

< string > array

39.137. LinkedResponseOfAddOtherSideAgentContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddOtherSideAgentContactToSaleResponse

warnings
optional

< string > array

39.138. LinkedResponseOfAddReferringAgentToListingResponse

Name Schema

links
optional

< Link > array

value
optional

AddReferringAgentToListingResponse

warnings
optional

< string > array

39.139. LinkedResponseOfAddReferringAgentToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddReferringAgentToSaleResponse

warnings
optional

< string > array

39.140. LinkedResponseOfAddSellerContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddSellerContactToSaleResponse

warnings
optional

< string > array

39.141. LinkedResponseOfAddSellerToListingResponse

Name Schema

links
optional

< Link > array

value
optional

AddSellerToListingResponse

warnings
optional

< string > array

39.142. LinkedResponseOfAddTitleContactToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

AddTitleContactToSaleResponse

warnings
optional

< string > array

39.143. LinkedResponseOfCreateDirectoryContactResponse

Name Schema

links
optional

< Link > array

value
optional

CreateDirectoryContactResponse

warnings
optional

< string > array

39.144. LinkedResponseOfCreateListingResponse

Name Schema

links
optional

< Link > array

value
optional

CreateListingResponse

warnings
optional

< string > array

39.145. LinkedResponseOfCreateSaleResponse

Name Schema

links
optional

< Link > array

value
optional

CreateSaleResponse

warnings
optional

< string > array

39.146. LinkedResponseOfCreateStageResponse

Name Schema

links
optional

< Link > array

value
optional

CreateStageResponse

warnings
optional

< string > array

39.147. LinkedResponseOfGetAddAttorneyContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddAttorneyContactToSaleFormResponse

warnings
optional

< string > array

39.148. LinkedResponseOfGetAddBuyerContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddBuyerContactToSaleFormResponse

warnings
optional

< string > array

39.149. LinkedResponseOfGetAddCommissionToListingFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddCommissionToListingFormResponse

warnings
optional

< string > array

39.150. LinkedResponseOfGetAddCommissionsToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddCommissionsToSaleFormResponse

warnings
optional

< string > array

39.151. LinkedResponseOfGetAddDocumentoToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddDocumentoToSaleFormResponse

warnings
optional

< string > array

39.152. LinkedResponseOfGetAddEscrowContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddEscrowContactToSaleFormResponse

warnings
optional

< string > array

39.153. LinkedResponseOfGetAddHomeWarrantyContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddHomeWarrantyContactToSaleFormResponse

warnings
optional

< string > array

39.154. LinkedResponseOfGetAddHomeWarrantyToListingFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddHomeWarrantyToListingFormResponse

warnings
optional

< string > array

39.155. LinkedResponseOfGetAddLenderContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddLenderContactToSaleFormResponse

warnings
optional

< string > array

39.156. LinkedResponseOfGetAddMiscellaneousContactToListingFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddMiscellaneousContactToListingFormResponse

warnings
optional

< string > array

39.157. LinkedResponseOfGetAddMiscellaneousContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddMiscellaneousContactToSaleFormResponse

warnings
optional

< string > array

39.158. LinkedResponseOfGetAddOtherSideAgentContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddOtherSideAgentContactToSaleFormResponse

warnings
optional

< string > array

39.159. LinkedResponseOfGetAddReferringAgentToListingFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddReferringAgentToListingFormResponse

warnings
optional

< string > array

39.160. LinkedResponseOfGetAddReferringAgentToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddReferringAgentToSaleFormResponse

warnings
optional

< string > array

39.161. LinkedResponseOfGetAddSellerContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddSellerContactToSaleFormResponse

warnings
optional

< string > array

39.162. LinkedResponseOfGetAddSellerToListingFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddSellerToListingFormResponse

warnings
optional

< string > array

39.163. LinkedResponseOfGetAddTitleContactToSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetAddTitleContactToSaleFormResponse

warnings
optional

< string > array

39.164. LinkedResponseOfGetAdditionalCommissionInformationLogToSaleResponse

Name Schema

links
optional

< Link > array

value
optional

GetAdditionalCommissionInformationLogToSaleResponse

warnings
optional

< string > array

39.165. LinkedResponseOfGetBulkExportResponse

Name Schema

links
optional

< Link > array

value
optional

GetBulkExportResponse

warnings
optional

< string > array

39.166. LinkedResponseOfGetChecklistTypesResponse

Name Schema

links
optional

< Link > array

value
optional

GetChecklistTypesResponse

warnings
optional

< string > array

39.167. LinkedResponseOfGetChecklistTypesResponse2

Name Schema

links
optional

< Link > array

value
optional

GetChecklistTypesResponse2

warnings
optional

< string > array

39.168. LinkedResponseOfGetContactsResponse

Name Schema

links
optional

< Link > array

value
optional

GetContactsResponse

warnings
optional

< string > array

39.169. LinkedResponseOfGetListingCommissionReferralFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetListingCommissionReferralFormResponse

warnings
optional

< string > array

39.170. LinkedResponseOfGetListingFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetListingFormResponse

warnings
optional

< string > array

39.171. LinkedResponseOfGetListingReferringAgentResponse

Name Schema

links
optional

< Link > array

value
optional

GetListingReferringAgentResponse

warnings
optional

< string > array

39.172. LinkedResponseOfGetListingResponse

Name Schema

links
optional

< Link > array

value
optional

GetListingResponse

warnings
optional

< string > array

39.173. LinkedResponseOfGetListingsResponse

Name Schema

links
optional

< Link > array

value
optional

GetListingsResponse

warnings
optional

< string > array

39.174. LinkedResponseOfGetOfficeResponse

Name Schema

links
optional

< Link > array

value
optional

GetOfficeResponse

warnings
optional

< string > array

39.175. LinkedResponseOfGetOfficesResponse

Name Schema

links
optional

< Link > array

value
optional

GetOfficesResponse

warnings
optional

< string > array

39.176. LinkedResponseOfGetSaleCommissionReferralFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetSaleCommissionReferralFormResponse

warnings
optional

< string > array

39.177. LinkedResponseOfGetSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetSaleFormResponse

warnings
optional

< string > array

39.178. LinkedResponseOfGetSaleResponse

Name Schema

links
optional

< Link > array

value
optional

GetSaleResponse

warnings
optional

< string > array

39.179. LinkedResponseOfGetSalesResponse

Name Schema

links
optional

< Link > array

value
optional

GetSalesResponse

warnings
optional

< string > array

39.180. LinkedResponseOfGetStagesResponse

Name Schema

links
optional

< Link > array

value
optional

GetStagesResponse

warnings
optional

< string > array

39.181. LinkedResponseOfGetSubscriberResponse

Name Schema

links
optional

< Link > array

value
optional

GetSubscriberResponse

warnings
optional

< string > array

39.182. LinkedResponseOfGetUpdateListingCoAgentsFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateListingCoAgentsFormResponse

warnings
optional

< string > array

39.183. LinkedResponseOfGetUpdateListingCommissionsFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateListingCommissionsFormResponse

warnings
optional

< string > array

39.184. LinkedResponseOfGetUpdateListingFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateListingFormResponse

warnings
optional

< string > array

39.185. LinkedResponseOfGetUpdateListingPropertyFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateListingPropertyFormResponse

warnings
optional

< string > array

39.186. LinkedResponseOfGetUpdateListingReferringAgentFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateListingReferringAgentFormResponse

warnings
optional

< string > array

39.187. LinkedResponseOfGetUpdateSaleCoAgentsFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateSaleCoAgentsFormResponse

warnings
optional

< string > array

39.188. LinkedResponseOfGetUpdateSaleCommissionBreakdownsFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateSaleCommissionBreakdownsFormResponse

warnings
optional

< string > array

39.189. LinkedResponseOfGetUpdateSaleCommissionSplitFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateSaleCommissionSplitFormResponse

warnings
optional

< string > array

39.190. LinkedResponseOfGetUpdateSaleCommissionsFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateSaleCommissionsFormResponse

warnings
optional

< string > array

39.191. LinkedResponseOfGetUpdateSaleContactFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateSaleContactFormResponse

warnings
optional

< string > array

39.192. LinkedResponseOfGetUpdateSaleFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateSaleFormResponse

warnings
optional

< string > array

39.193. LinkedResponseOfGetUpdateSalePropertyFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateSalePropertyFormResponse

warnings
optional

< string > array

39.194. LinkedResponseOfGetUpdateSaleReferringAgentFormResponse

Name Schema

links
optional

< Link > array

value
optional

GetUpdateSaleReferringAgentFormResponse

warnings
optional

< string > array

39.195. LinkedResponseOfGetUsersResponse

Name Schema

links
optional

< Link > array

value
optional

GetUsersResponse

warnings
optional

< string > array

39.196. LinkedResponseOfPatchEarnestMoneyDepositResponse

Name Schema

links
optional

< Link > array

value
optional

PatchEarnestMoneyDepositResponse

warnings
optional

< string > array

39.197. LinkedResponseOfPatchListingDocumentResponse

Name Schema

links
optional

< Link > array

value
optional

PatchListingDocumentResponse

warnings
optional

< string > array

39.198. LinkedResponseOfPatchStageResponse

Name Schema

links
optional

< Link > array

value
optional

PatchStageResponse

warnings
optional

< string > array

39.199. LinkedResponseOfStagePatchResponse

Name Schema

links
optional

< Link > array

value
optional

StagePatchResponse

warnings
optional

< string > array

39.200. LinkedResponseOfUpdateChecklistTypeResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateChecklistTypeResponse

warnings
optional

< string > array

39.201. LinkedResponseOfUpdateListingAgentResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateListingAgentResponse

warnings
optional

< string > array

39.202. LinkedResponseOfUpdateListingChecklistTypeResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateListingChecklistTypeResponse

warnings
optional

< string > array

39.203. LinkedResponseOfUpdateListingCoAgentsResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateListingCoAgentsResponse

warnings
optional

< string > array

39.204. LinkedResponseOfUpdateListingContactForm

Name Schema

links
optional

< Link > array

value
optional

UpdateListingContactForm

warnings
optional

< string > array

39.205. LinkedResponseOfUpdateListingContactResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateListingContactResponse

warnings
optional

< string > array

39.206. LinkedResponseOfUpdateListingCustomFieldsResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateListingCustomFieldsResponse

warnings
optional

< string > array

39.207. LinkedResponseOfUpdateListingOfficeResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateListingOfficeResponse

warnings
optional

< string > array

39.208. LinkedResponseOfUpdateListingPropertyResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateListingPropertyResponse

warnings
optional

< string > array

39.209. LinkedResponseOfUpdateListingResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateListingResponse

warnings
optional

< string > array

39.210. LinkedResponseOfUpdateSaleAgentResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleAgentResponse

warnings
optional

< string > array

39.211. LinkedResponseOfUpdateSaleCoAgentsResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleCoAgentsResponse

warnings
optional

< string > array

39.212. LinkedResponseOfUpdateSaleCommissionBreakdownResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleCommissionBreakdownResponse

warnings
optional

< string > array

39.213. LinkedResponseOfUpdateSaleCommissionSplitResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleCommissionSplitResponse

warnings
optional

< string > array

39.214. LinkedResponseOfUpdateSaleCommissionsResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleCommissionsResponse

warnings
optional

< string > array

39.215. LinkedResponseOfUpdateSaleContactResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleContactResponse

warnings
optional

< string > array

39.216. LinkedResponseOfUpdateSaleCustomFieldsResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleCustomFieldsResponse

warnings
optional

< string > array

39.217. LinkedResponseOfUpdateSaleOfficeResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleOfficeResponse

warnings
optional

< string > array

39.218. LinkedResponseOfUpdateSalePropertyResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSalePropertyResponse

warnings
optional

< string > array

39.219. LinkedResponseOfUpdateSaleResponse

Name Schema

links
optional

< Link > array

value
optional

UpdateSaleResponse

warnings
optional

< string > array

39.220. ListingDTO

Name Schema

agentGuid
required

string (guid)

checklistType
optional

string

coAgentGuids
optional

< string (guid) > array

coListingAgentGuid
optional

string (guid)

commercialLease
optional

CommercialLeaseDTO

commission
optional

CommissionDTO

commissionReferral
optional

CommissionReferral

company
optional

string

createdByGuid
required

string (guid)

createdOn
required

string (date-time)

customFields
optional

object

expirationDate
required

string (date-time)

fileId
optional

string

homeWarranty
optional

HomeWarrantyContactDTO2

listingDate
required

string (date-time)

listingGuid
required

string (guid)

listingPrice
required

number (decimal)

miscContact
optional

MiscellaneousContactDTO2

mlsNumber
optional

string

officeGuid
optional

string (guid)

otherSource
optional

string

property
optional

PropertyDTO

referringAgentGuid
optional

string (guid)

sellers
optional

< SellerDTO2 > array

source
optional

string

stage
optional

StageDTO

status
optional

string

type
optional

string

39.221. ListingForm

Name Description Schema

agentGuid
required

The agent that this Listing is created for.
Minimum length : 1

string (guid)

checklistTypeId
required

integer (int32)

coListingAgentGuid
optional

string (guid)

commercialLease
optional

CommercialLeaseDTO3

customFields
optional

CreateListingCustomFieldsDTO

expirationDate
required

string (date-time)

fileID
optional

string

isOfficeLead
optional

boolean

listingDate
optional

string (date-time)

listingPrice
required

number (decimal)

mlsNumber
optional

string

officeGuid
optional

Office guid that the Listing will be created in.

string (guid)

otherSource
optional

string

property
optional

PropertyDTO2

sourceId
optional

integer (int32)

39.222. ListingReferringAgentDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
optional

string

lastName
optional

string

phoneNumber
optional

string

publicID
optional

string

state
optional

string

streetAddress
optional

string

streetNumber
optional

string

zip
optional

string

39.223. ListingsDTO

Name Schema

expirationDate
required

string (date-time)

link
optional

Link

listingGuid
required

string (guid)

listingPrice
required

number (decimal)

mlsNumber
optional

string

propertyAddress
optional

string

status
optional

string

39.224. MiscellaneousContactDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
optional

string

lastName
optional

string

miscContactType
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.225. MiscellaneousContactDTO2

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

lastName
optional

string

miscContactType
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.226. MiscellaneousContactDTO3

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

lastName
optional

string

miscContactType
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.227. MultipleDocumentUploadPayload

Name Schema

uploads
optional

< DocumentUploadPayload > array

39.228. OfficeDTO

Name Schema

guid
required

string (guid)

name
optional

string

39.229. OfficesDTO

Name Schema

officeGuid
required

string (guid)

officeName
optional

string

39.230. OtherSideAgentContactDTO

Name Schema

alternatePhone
optional

string

brokerTaxId
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

lastName
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.231. PatchDocumentDocumentForm

Name Schema

fileName
optional

string

39.232. PatchEarnestMoneyDepositResponse

Name Schema

additionalDepositAmount
optional

number (decimal)

additionalDepositDueDate
optional

string (date-time)

dateOfCheck
optional

string (date-time)

datePostedToLogBook
optional

string (date-time)

depositAmount
optional

number (decimal)

depositDueDate
optional

string (date-time)

isEarnestMoneyHeld
optional

boolean

saleGuid
required

string (guid)

39.233. PatchListingCommissionReferralContactForm

Name Schema

email
optional

string

firstName
optional

string

lastName
optional

string

phoneNumber
optional

string

39.234. PatchListingCommissionReferralForm

Name Schema

amount
optional

number (decimal)

brokerName
optional

string

contact
optional

PatchListingCommissionReferralContactForm

percent
optional

number (decimal)

39.235. PatchListingDocumentForm

Name Description Schema

fileName
optional

The filename of the document

string

folder
optional

Can be Admin or Trash or null

string

39.236. PatchListingDocumentResponse

Name Schema

documentGuid
required

string (guid)

fileName
optional

string

folder
optional

string

39.237. PatchOfficeForm

Name Schema

name
optional

string

39.238. PatchSaleCommissionReferralContactForm

Name Schema

email
optional

string

firstName
optional

string

lastName
optional

string

phoneNumber
optional

string

39.239. PatchSaleCommissionReferralForm

Name Schema

amount
optional

number (decimal)

brokerName
optional

string

contact
optional

PatchSaleCommissionReferralContactForm

percent
optional

number (decimal)

typeId
optional

integer (int32)

39.240. PatchSaleDocumentForm

Name Description Schema

fileName
optional

The filename of the document

string

folder
optional

Can be Admin or Trash or null

string

39.241. PatchStageResponse

Name Schema

changedStage
optional

StageChanges

39.242. PropertyDTO

Name Schema

areasqft
optional

string

city
optional

string

county
optional

string

direction
optional

string

state
optional

string

streetAddress
optional

string

streetNumber
optional

string

unit
optional

string

yearBuilt
optional

integer (int32)

zip
optional

string

39.243. PropertyDTO2

Name Description Schema

areasqft
optional

string

city
required

Minimum length : 1

string

county
optional

string

direction
optional

string

state
required

Minimum length : 1

string

streetAddress
required

Minimum length : 1

string

streetNumber
required

Minimum length : 1

string

unit
optional

string

yearBuilt
optional

integer (int32)

zip
required

Minimum length : 1

string

39.244. PropertyDTO3

Name Schema

city
optional

string

county
optional

string

direction
optional

string

state
optional

string

streetAddress
optional

string

streetNumber
optional

string

unit
optional

string

yearBuilt
optional

integer (int32)

zip
optional

string

39.245. PropertyDTO4

Name Description Schema

city
required

Minimum length : 1

string

county
optional

string

direction
optional

string

state
required

Minimum length : 1

string

streetAddress
required

Minimum length : 1

string

streetNumber
required

Minimum length : 1

string

unit
optional

string

yearBuilt
optional

integer (int32)

zip
required

Minimum length : 1

string

39.246. SaleDTO

Name Schema

actualClosingDate
optional

string (date-time)

agentGuid
required

string (guid)

attorneyContact
optional

< AttorneyContactDTO > array

buyers
optional

< BuyerDTO > array

checklistType
optional

string

coAgentGuids
optional

< string (guid) > array

coBrokerCompany
optional

string

commercialLease
optional

CommercialLeaseDTO4

commission
optional

CommissionDTO2

commissionBreakdowns
optional

< CommissionBreakdownDTO2 > array

commissionReferral
optional

CommissionReferral2

commissionSplits
optional

< CommissionSplitsDTO > array

contractAcceptanceDate
required

string (date-time)

createdByGuid
required

string (guid)

createdOn
required

string (date-time)

customFields
optional

object

dealType
optional

string

earnestMoneyDeposit
optional

EarnestMoneyDepositDTO

escrowClosingDate
optional

string (date-time)

escrowContact
optional

EscrowContactDTO

escrowNumber
optional

string

homeWarrantyContact
optional

HomeWarrantyContactDTO3

isOfficeLead
required

boolean

lenderContact
optional

LenderContactDTO

listingGuid
optional

string (guid)

listingPrice
required

number (decimal)

miscContact
optional

MiscellaneousContactDTO3

mlsNumber
optional

string

officeGuid
optional

string (guid)

otherSideAgentContact
optional

OtherSideAgentContactDTO

otherSource
optional

string

property
optional

PropertyDTO3

saleGuid
required

string (guid)

salePrice
required

number (decimal)

sellers
optional

< SellerDTO3 > array

source
optional

string

stage
optional

StageDTO2

status
optional

string

statusId
required

integer (int32)

titleContact
optional

TitleContactDTO

39.247. SaleForm

Name Description Schema

agentGuid
required

The agent that this sale is created for.
Minimum length : 1

string (guid)

apn
optional

string

checklistTypeId
required

integer (int32)

commercialLease
optional

CommercialLeaseDTO6

contractAcceptanceDate
optional

string (date-time)

customFields
optional

CreateSaleCustomFieldsDTO

escrowClosingDate
optional

string (date-time)

escrowNumber
optional

string

fileId
optional

string

isOfficeLead
optional

boolean

mlsNumber
optional

string

officeGuid
required

Office guid that the sale will be created in.
Minimum length : 1

string (guid)

otherSource
optional

Required only for certain SourceId fields

string

property
optional

PropertyDTO4

salePrice
optional

number (decimal)

sourceId
optional

SourceId can be retrieved from the AllowableSelections list.

integer (int32)

statusId
required

integer (int32)

39.248. SalesDTO

Name Schema

actualClosingDate
optional

string (date-time)

escrowClosingDate
optional

string (date-time)

link
optional

Link

propertyAddress
optional

string

saleGuid
required

string (guid)

status
optional

string

39.249. SellerDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
optional

string

isTrustCompanyOrOtherEntity
required

boolean

lastName
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.250. SellerDTO2

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

isTrustCompanyOrOtherEntity
required

boolean

lastName
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.251. SellerDTO3

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

isTrustCompanyOrOtherEntity
required

boolean

lastName
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.252. StageChanges

Name Schema

id
required

integer (int32)

name
optional

string

39.253. StageDTO

Name Schema

id
required

integer (int32)

name
optional

string

39.254. StageDTO2

Name Schema

id
required

integer (int32)

name
optional

string

39.255. StageDTO3

Name Schema

id
required

integer (int32)

isDefault
required

boolean

name
optional

string

39.256. StagePatchRequest

Name Schema

id
required

integer (int32)

39.257. StagePatchRequest2

Name Schema

id
required

integer (int32)

39.258. StagePatchResponse

Name Schema

saleGuid
required

string (guid)

stageId
required

integer (int32)

39.259. TitleContactDTO

Name Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

contactGuid
required

string (guid)

email
optional

string

fax
optional

string

firstName
optional

string

lastName
optional

string

notes
optional

string

phoneNumber
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

zip
optional

string

39.260. TransactionType

Type : enum (Listing, Sale)

39.261. UpdateChecklistTypeResponse

Type : object

39.262. UpdateListingAgentForm

Name Description Schema

agentGuid
required

Minimum length : 1

string (guid)

39.263. UpdateListingAgentResponse

Type : object

39.264. UpdateListingChecklistTypeForm

Name Schema

checklistTypeId
required

integer (int32)

39.265. UpdateListingChecklistTypeResponse

Type : object

39.266. UpdateListingCoAgentsForm

Name Schema

coAgentGuids
optional

< string (guid) > array

39.267. UpdateListingCoAgentsResponse

Type : object

39.268. UpdateListingCommissionsForm

Name Schema

commissionBreakdown
optional

string

listingCommissionAmount
optional

number (decimal)

listingCommissionPercent
optional

number (decimal)

officeGrossCommission
optional

number (decimal)

referralAmount
optional

number (decimal)

referralAmountPercent
optional

number (decimal)

saleCommissionPercent
optional

number (decimal)

salesCommissionAmount
optional

number (decimal)

transCoordinatorFee
optional

number (decimal)

39.269. UpdateListingContactForm

Type : object

39.270. UpdateListingContactResponse

Name Schema

contactGuid
required

string (guid)

39.271. UpdateListingCustomFieldsForm

Name Schema

comingSoon
optional

string

conciergeProjectNumber
optional

string

isConcierge
optional

string

listingId
optional

string

serviceType
optional

string

39.272. UpdateListingCustomFieldsResponse

Name Schema

comingSoon
optional

string

conciergeProjectNumber
optional

string

isConcierge
optional

string

listingGuid
required

string (guid)

listingId
optional

string

serviceType
optional

string

39.273. UpdateListingOfficeForm

Name Schema

officeGuid
optional

string (guid)

39.274. UpdateListingOfficeResponse

Type : object

39.275. UpdateListingPropertyForm

Name Description Schema

areasqft
optional

string

city
required

Minimum length : 1

string

county
optional

string

direction
optional

string

state
required

Minimum length : 1

string

streetAddress
required

Minimum length : 1

string

streetNumber
required

Minimum length : 1

string

unit
optional

string

yearBuilt
required

integer (int32)

zip
required

Minimum length : 1

string

39.276. UpdateListingPropertyResponse

Type : object

39.277. UpdateListingReferringAgentForm

Name Description Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
required

Minimum length : 1

string

lastName
required

Minimum length : 1

string

phoneNumber
optional

string

publicID
optional

string

state
optional

string

streetAddress
optional

string

streetNumber
optional

string

zip
optional

string

39.278. UpdateListingResponse

Type : object

39.279. UpdateListingsForm

Name Schema

coListingAgentGuid
optional

string (guid)

commercialLease
optional

CommercialLeaseDTO2

expirationDate
required

string (date-time)

fileID
optional

string

isOfficeLead
optional

boolean

listingDate
optional

string (date-time)

listingPrice
required

number (decimal)

mlsNumber
optional

string

otherSource
optional

string

sourceId
required

integer (int32)

39.280. UpdateSaleAgentForm

Name Description Schema

agentGuid
required

Minimum length : 1

string (guid)

39.281. UpdateSaleAgentResponse

Type : object

39.282. UpdateSaleChecklistTypeForm

Name Schema

checklistTypeId
required

integer (int32)

39.283. UpdateSaleCoAgentsForm

Name Schema

coAgentGuids
optional

< string (guid) > array

39.284. UpdateSaleCoAgentsResponse

Type : object

39.285. UpdateSaleCommissionBreakdownForm

Name Schema

commissionBreakdowns
optional

< CommissionBreakdownDTO > array

39.286. UpdateSaleCommissionBreakdownResponse

Type : object

39.287. UpdateSaleCommissionSplitForm

Name Schema

commissionSplits
optional

< CommissionSplit > array

39.288. UpdateSaleCommissionSplitResponse

Type : object

39.289. UpdateSaleCommissionsForm

Name Description Schema

commissionBreakdownDetails
optional

string

dateOfCheck
optional

string (date-time)

datePostedToLogBook
optional

string (date-time)

listingCommissionAmount
optional

If required, either percent or amount field needs to be filled

number (decimal)

listingCommissionPercent
optional

If required, either percent or amount field needs to be filled

number (decimal)

otherDeductions
optional

number (decimal)

personalDeal
required

boolean

saleCommissionAmount
optional

If required, either percent or amount field needs to be filled

number (decimal)

saleCommissionPercent
optional

If required, either percent or amount field needs to be filled

number (decimal)

transactionCoordinatorFee
optional

number (decimal)

transactionCoordinatorName
optional

string

39.290. UpdateSaleCommissionsResponse

Type : object

39.291. UpdateSaleContactResponse

Name Schema

contactGuid
required

string (guid)

39.292. UpdateSaleCustomFieldsForm

Name Schema

conciergeProjectNumber
optional

string

isConcierge
optional

string

serviceType
optional

string

39.293. UpdateSaleCustomFieldsResponse

Name Schema

conciergeProjectNumber
optional

string

isConcierge
optional

string

saleGuid
required

string (guid)

serviceType
optional

string

39.294. UpdateSaleForm

Name Description Schema

actualClosingDate
optional

string (date-time)

apn
optional

string

commercialLease
optional

CommercialLeaseDTO5

contractAcceptanceDate
required

string (date-time)

escrowClosingDate
required

string (date-time)

escrowNumber
optional

string

fileId
optional

string

isOfficeLead
required

boolean

listingPrice
optional

number (decimal)

mlsNumber
required

Minimum length : 1

string

otherSource
optional

Required only for certain SourceId fields

string

salePrice
required

number (decimal)

sourceId
optional

SourceId can be retrieved from the AllowableSelections list.

integer (int32)

39.295. UpdateSaleOfficeForm

Name Description Schema

officeGuid
required

Minimum length : 1

string (guid)

39.296. UpdateSaleOfficeResponse

Type : object

39.297. UpdateSalePropertyForm

Name Description Schema

city
required

Minimum length : 1

string

county
optional

string

direction
optional

string

state
required

Minimum length : 1

string

streetAddress
required

Minimum length : 1

string

streetNumber
required

Minimum length : 1

string

unit
optional

string

yearBuilt
required

integer (int32)

zip
required

Minimum length : 1

string

39.298. UpdateSalePropertyResponse

Type : object

39.299. UpdateSaleReferringAgentForm

Name Description Schema

alternatePhone
optional

string

city
optional

string

company
optional

string

email
optional

string

fax
optional

string

firstName
required

Minimum length : 1

string

lastName
required

Minimum length : 1

string

phoneNumber
optional

string

publicID
optional

string

state
optional

string

streetAddress
optional

string

streetNumber
optional

string

zip
optional

string

39.300. UpdateSaleResponse

Type : object

39.301. UserDTO

Name Schema

email
optional

string

firstName
optional

string

lastName
optional

string

userGuid
required

string (guid)

userType
optional

string

39.302. UserDTO2

Name Schema

alternatePhone
optional

string

city
optional

string

email
optional

string

firstName
optional

string

lastName
optional

string

phone
optional

string

publicId
optional

string

state
optional

string

streetName
optional

string

streetNumber
optional

string

userGuid
required

string (guid)

userType
optional

string

zipCode
optional

string
1. Time could change in the future without notice.
2. Duration could change in the future without notice.