SkySlope
API docs by Redocly

SkySlope Partnership API Reference (1.0.0)

Download OpenAPI specification:

Support: [email protected] URL: https://support.skyslope.com/hc/en-us Terms of Service

Introduction

The SkySlope Forms API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

NOTE: Endpoints marked with an asterisk (*) will be available to our partners in the near future.

Authentication

This API uses OAuth 2.0 authorization code flow to obtain an access token that can be used to authenticate subsequent API requests.

Access Tokens

Request

To obtain an access token, first redirect the user to the authorization endpoint:

https://accounts.skyslope.com/oauth2/authorize?
  response_type=code
  &client_id={YOUR_CLIENT_ID}
  &redirect_uri={YOUR_REDIRECT_URI}
  &scope=forms.files
  &state={RANDOM_STATE_VALUE}
  &code_challenge={CODE_CHALLENGE}
  &code_challenge_method=S256

After the user authorizes your application, they'll be redirected back to your redirect URI with an authorization code. Exchange this code for an access token by making a POST request to the token endpoint:

POST /oauth2/token HTTP/1.1
Host: accounts.skyslope.com
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code
&client_id={YOUR_CLIENT_ID}
&client_secret={YOUR_CLIENT_SECRET}
&code={AUTHORIZATION_CODE}
&redirect_uri={YOUR_REDIRECT_URI}
&code_verifier={CODE_VERIFIER}

Usage

Authentication to the API is performed by including your access token in the Authorization header of your API requests with the Bearer authentication scheme:

GET /partner/api/files HTTP/1.1
Host: forms.skyslope.com
Authorization: Bearer {YOUR_ACCESS_TOKEN}

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Refresh Tokens

Refresh tokens allow you to obtain new access tokens without requiring the user to re-authenticate. When you first complete the OAuth flow, you'll receive both an access token and a refresh token.

Request

To receive a refresh token, include the offline_access scope in your initial authorization request:

https://accounts.skyslope.com/oauth2/authorize?
  response_type=code
  &client_id={YOUR_CLIENT_ID}
  &scope=forms.files offline_access
  &redirect_uri={YOUR_REDIRECT_URI}

Usage

When your access token expires, make a POST request to the token endpoint:

POST /oauth2/token HTTP/1.1
Host: accounts.skyslope.com
Content-Type: application/x-www-form-urlencoded

grant_type=refresh_token
&client_id={YOUR_CLIENT_ID}
&client_secret={YOUR_CLIENT_SECRET}
&refresh_token={YOUR_REFRESH_TOKEN}

This will return a new access token and refresh token pair.

Security Best Practices

  • Store refresh tokens securely on your backend server, never on client side
  • Encrypt refresh tokens at rest using strong encryption
  • Rotate refresh token on each use
  • Set up monitoring for unusual refresh token usage patterns
  • If a refresh token is compromised, revoke it immediately using the token revocation endpoint
  • Implement automatic cleanup of unused refresh tokens

Files

Create Listing or Transaction File

Creates a listing or a transaction file and returns the file id.

REQUIRED SCOPES:
forms.files

Request Body schema: application/json
name
string

The name of the file.

representationType
string
Enum: "Buyer" "Seller" "Tenant" "Landlord"

The representation type of the file.

object

The property that the file is associated with.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "representationType": "Buyer",
  • "property": {
    }
}

Response samples

Content type
application/json
{
  • "fileId": 477309
}

Get Files

Retrieve the files that the user has access to.

REQUIRED SCOPES:
forms.files
forms.files.read

query Parameters
page
integer >= 1
Default: 1

The page number to retrieve.

pageSize
integer [ 1 .. 500 ]
Default: 10

The number of files returned per page.

filters
string

A comma separated sieve filter to that will be applied to the results. Ex: filters=representationtype==Buyer,(createddate)>=2024-01-01,(createddate)<=2024-01-31

sorts
string

A sieve list of sort fields to sort the results by.

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 1,
  • "files": [
    ]
}

Update File Details

Update the file details of a listing or transaction file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer

The id of the file to update.

Request Body schema: application/json
name
string

The name of the file.

object

File data that can be updated.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fileData": {
    }
}

Response samples

Content type
application/json
{
  • "fileId": 477309,
  • "didAddendumsChange": false
}

Update File

Update the file of a listing or transaction file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer

The id of the file to update.

Request Body schema: application/json
required
mlsNumber
string

The mls number of the file.

purchasePrice
number

The purchase price of the property.

closingDateTime
string

The closing date of the file in the format of YYYY-MM-DDTHH:MM:SSZ.

acceptanceDateTime
string

The acceptanced date of the file in the format of YYYY-MM-DDTHH:MM:SSZ.

required
object

The property that the file is associated with.

required
Array of objects

An array of the commissions for the file.

required
Array of objects

An array of contacts for the file.

Responses

Request samples

Content type
application/json
{
  • "mlsNumber": "string",
  • "purchasePrice": 0,
  • "closingDateTime": "string",
  • "acceptanceDateTime": "string",
  • "property": {
    },
  • "commissions": [
    ],
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "fileId": 0,
  • "commissions": [
    ],
  • "contacts": [
    ]
}

Get File

Retrieve the details of a listing or transaction file.

REQUIRED SCOPES:
forms.files
forms.files.read

path Parameters
fileId
required
integer >= 1

The id of the file to retrieve.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "File Name",
  • "type": "File",
  • "representationType": "Buyer",
  • "templateCategory": "Landlord",
  • "closingDateTime": "2023-12-31T12:12:12.123Z",
  • "acceptanceDateTime": "2023-12-31T12:12:12.123Z",
  • "meta": {
    },
  • "mlsNumber": "1589519",
  • "purchasePrice": 1598000,
  • "fileData": {
    },
  • "transactionMeta": {
    },
  • "property": {
    },
  • "contacts": [
    ],
  • "commissions": [
    ],
  • "documentData": [
    ],
  • "isDeleted": false,
  • "isArchived": false,
  • "createdDate": "2023-12-31T12:12:12.123Z",
  • "createdBy": "iajv98j498j98vasj4h",
  • "lastUpdated": "2023-12-31T12:12:12.123Z",
  • "updatedBy": "iajv98j498j98vasj4h",
  • "ownedBy": "iajv98j498j98vasj4h"
}

Add Contact to File

Add a contact to a file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer >= 1

The id of the file to add the contact to.

Request Body schema: application/json
required

The body of the request to add a contact to a file.

actionAttribute
string
Enum: "Empty" "NeedsToSign" "CanView" "ReceivesCopy" "NoAction"

Actions for contact to participate in.

NeedsToSign: Contact will will receive an email containing a document needing to be signed

ReceivesCopy: Contact to receive a copy of Signed Documents once signing is complete

No Action: Contact needs not further action

type
required
string
Enum: "Broker" "Buyer" "BuyerAgent" "BuyersLawyer" "EscrowOfficer" "LoanOfficer" "Other" "Seller" "SellerAgent" "SellersLawyer" "TitleOfficer"

The role that a contact has been assigned.

isEntity
boolean

Evaluates to true if the contact is an entity.

isUser
boolean

Evaluates to true if the contact is the also the agent (self).

firstName
required
string

The first name of the contact.

middleName
string

The middle name of the contact.

lastName
required
string

The last name of the contact.

suffix
string

The suffix of the contact.

email
string

The email of the contact.

primaryPhoneNumber
string

The primary phone number of the contact.

brokeragePhoneNumber
string

The brokerage phone number of the contact.

faxPhoneNumber
string

The fax phone number of the contact.

object

The primary address of the contact.

companyName
string

The company name that the contact belongs to.

agentLicenseNumber
string

The agent license number of the contact.

agentMLSCode
string

The agent mls code of the contact.

brokerLicenseNumber
string

The broker license number of the contact.

brokerMLSCode
string

The broker mls code of the contact.

brokerageLicenseNumber
string

The brokerage license number of the contact.

brokerageMLSCode
string

The brokerage mls code of the contact.

lenderLicenseNumber
string

The lender license number of the contact.

Responses

Request samples

Content type
application/json
{
  • "actionAttribute": "Empty",
  • "type": "Broker",
  • "isEntity": true,
  • "isUser": true,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "suffix": "string",
  • "email": "string",
  • "primaryPhoneNumber": "string",
  • "brokeragePhoneNumber": "string",
  • "faxPhoneNumber": "string",
  • "primaryAddress": {
    },
  • "companyName": "string",
  • "agentLicenseNumber": "string",
  • "agentMLSCode": "string",
  • "brokerLicenseNumber": "string",
  • "brokerMLSCode": "string",
  • "brokerageLicenseNumber": "string",
  • "brokerageMLSCode": "string",
  • "lenderLicenseNumber": "string"
}

Response samples

Content type
application/json
{
  • "contactId": 123456
}

Update Contact in File.

Update a contact in a file.

REQUIRED SCOPES:
forms.files

path Parameters
contactId
required
integer >= 1

The id of the contact to update.

Request Body schema: application/json
required

The body of the request to add a contact to a file.

actionAttribute
string
Enum: "Empty" "NeedsToSign" "CanView" "ReceivesCopy" "NoAction"

Actions for contact to participate in.

NeedsToSign: Contact will will receive an email containing a document needing to be signed

ReceivesCopy: Contact to receive a copy of Signed Documents once signing is complete

No Action: Contact needs not further action

type
required
string
Enum: "Broker" "Buyer" "BuyerAgent" "BuyersLawyer" "EscrowOfficer" "LoanOfficer" "Other" "Seller" "SellerAgent" "SellersLawyer" "TitleOfficer"

The role that a contact has been assigned.

isEntity
boolean

Evaluates to true if the contact is an entity.

isUser
boolean

Evaluates to true if the contact is the also the agent (self).

firstName
required
string

The first name of the contact.

middleName
string

The middle name of the contact.

lastName
required
string

The last name of the contact.

suffix
string

The suffix of the contact.

email
string

The email of the contact.

primaryPhoneNumber
string

The primary phone number of the contact.

brokeragePhoneNumber
string

The brokerage phone number of the contact.

faxPhoneNumber
string

The fax phone number of the contact.

object

The primary address of the contact.

companyName
string

The company name that the contact belongs to.

agentLicenseNumber
string

The agent license number of the contact.

agentMLSCode
string

The agent mls code of the contact.

brokerLicenseNumber
string

The broker license number of the contact.

brokerMLSCode
string

The broker mls code of the contact.

brokerageLicenseNumber
string

The brokerage license number of the contact.

brokerageMLSCode
string

The brokerage mls code of the contact.

lenderLicenseNumber
string

The lender license number of the contact.

Responses

Request samples

Content type
application/json
{
  • "actionAttribute": "Empty",
  • "type": "Broker",
  • "isEntity": true,
  • "isUser": true,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "suffix": "string",
  • "email": "string",
  • "primaryPhoneNumber": "string",
  • "brokeragePhoneNumber": "string",
  • "faxPhoneNumber": "string",
  • "primaryAddress": {
    },
  • "companyName": "string",
  • "agentLicenseNumber": "string",
  • "agentMLSCode": "string",
  • "brokerLicenseNumber": "string",
  • "brokerMLSCode": "string",
  • "brokerageLicenseNumber": "string",
  • "brokerageMLSCode": "string",
  • "lenderLicenseNumber": "string"
}

Response samples

Content type
application/json
{
  • "contactId": 123456
}

Add Contacts to File

Add one or more contacts to a file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer >= 1

The id of the file to add the contacts to.

Request Body schema: application/json

The body of the request to add multiple contacts to a file.

Array of objects

The contacts to add to the file.

Responses

Request samples

Content type
application/json
{
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "totalRecordsAdded": 3
}

Delete Contact from File.

Delete a contact from a file.

REQUIRED SCOPES:
forms.files

path Parameters
contactId
required
integer >= 1

The id of the contact to delete.

fileId
required
integer >= 1

The id of the file to delete the contact from.

Responses

Response samples

Content type
application/json
{
  • "contactId": 123456
}

Get Signed Documents

Retrieve the signed documents for a file.

REQUIRED SCOPES:
forms.documents
forms.documents.read

path Parameters
fileId
required
integer >= 1

The id of the file to retrieve signed documents for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subscribe To Signed Documents Webhook

Subscribe a file to the signed documents webhook.

REQUIRED SCOPES:
forms.webhooks

path Parameters
fileId
required
integer >= 1

The id of the file to subscribe to the signed documents webhook.

Request Body schema: application/json
required
webhookUrl
required
string

The url to send the webhook response to when documents are signed documents.

Responses

Request samples

Content type
application/json
{
  • "webhookUrl": "string"
}

Response samples

Content type
application/json
{
  • "subscribed": true
}

Get Envelopes in File

Get the envelopes associated with a file.

REQUIRED SCOPES:
forms.files
forms.files.read

path Parameters
fileId
required
integer >= 1

The id of the file to retrieve envelopes for.

query Parameters
page
integer >= 1
Default: 1

The page number to retrieve.

pageSize
integer [ 1 .. 500 ]
Default: 10

The number of files returned per page.

filters
string

A sieve filter to that will be applied to the results.

sorts
string

A sieve list of sort fields to sort the results by.

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 0,
  • "envelopes": [
    ]
}

Create Envelope in File

Create an envelope for a file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer >= 1

The id of the file to add the envelope to.

Request Body schema: application/json
required
envelopeName
required
string

The name of the envelope to add to the file.

documentIds
required
Array of numbers

An array of the ids of the documents to add to the envelope.

Responses

Request samples

Content type
application/json
{
  • "envelopeName": "string",
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "fileId": 539181,
  • "envelope": {
    }
}

Add Documents to File

Add one or more documents to a file.

REQUIRED SCOPES:
forms.files
forms.documents

path Parameters
fileId
required
integer >= 1

The id of the file to add the documents to.

Request Body schema: application/json
required
formIds
required
Array of integers non-empty

An array of the Form Ids of the Forms to add to the file.

Responses

Request samples

Content type
application/json
{
  • "formIds": [
    ]
}

Response samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Apply Templates to File *

Apply templates to a file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer >= 1

The id of the file to apply templates to.

Request Body schema: application/json
required
templateIds
required
Array of integers

List of templates to apply to a File

Responses

Request samples

Content type
application/json
{
  • "templateIds": [
    ]
}

Response samples

Content type
application/json
{
  • "result": 667309,
  • "statusCode": "OK",
  • "errors": [ ]
}

Contacts

Add Contact to File

Add a contact to a file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer >= 1

The id of the file to add the contact to.

Request Body schema: application/json
required

The body of the request to add a contact to a file.

actionAttribute
string
Enum: "Empty" "NeedsToSign" "CanView" "ReceivesCopy" "NoAction"

Actions for contact to participate in.

NeedsToSign: Contact will will receive an email containing a document needing to be signed

ReceivesCopy: Contact to receive a copy of Signed Documents once signing is complete

No Action: Contact needs not further action

type
required
string
Enum: "Broker" "Buyer" "BuyerAgent" "BuyersLawyer" "EscrowOfficer" "LoanOfficer" "Other" "Seller" "SellerAgent" "SellersLawyer" "TitleOfficer"

The role that a contact has been assigned.

isEntity
boolean

Evaluates to true if the contact is an entity.

isUser
boolean

Evaluates to true if the contact is the also the agent (self).

firstName
required
string

The first name of the contact.

middleName
string

The middle name of the contact.

lastName
required
string

The last name of the contact.

suffix
string

The suffix of the contact.

email
string

The email of the contact.

primaryPhoneNumber
string

The primary phone number of the contact.

brokeragePhoneNumber
string

The brokerage phone number of the contact.

faxPhoneNumber
string

The fax phone number of the contact.

object

The primary address of the contact.

companyName
string

The company name that the contact belongs to.

agentLicenseNumber
string

The agent license number of the contact.

agentMLSCode
string

The agent mls code of the contact.

brokerLicenseNumber
string

The broker license number of the contact.

brokerMLSCode
string

The broker mls code of the contact.

brokerageLicenseNumber
string

The brokerage license number of the contact.

brokerageMLSCode
string

The brokerage mls code of the contact.

lenderLicenseNumber
string

The lender license number of the contact.

Responses

Request samples

Content type
application/json
{
  • "actionAttribute": "Empty",
  • "type": "Broker",
  • "isEntity": true,
  • "isUser": true,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "suffix": "string",
  • "email": "string",
  • "primaryPhoneNumber": "string",
  • "brokeragePhoneNumber": "string",
  • "faxPhoneNumber": "string",
  • "primaryAddress": {
    },
  • "companyName": "string",
  • "agentLicenseNumber": "string",
  • "agentMLSCode": "string",
  • "brokerLicenseNumber": "string",
  • "brokerMLSCode": "string",
  • "brokerageLicenseNumber": "string",
  • "brokerageMLSCode": "string",
  • "lenderLicenseNumber": "string"
}

Response samples

Content type
application/json
{
  • "contactId": 123456
}

Update Contact in File.

Update a contact in a file.

REQUIRED SCOPES:
forms.files

path Parameters
contactId
required
integer >= 1

The id of the contact to update.

Request Body schema: application/json
required

The body of the request to add a contact to a file.

actionAttribute
string
Enum: "Empty" "NeedsToSign" "CanView" "ReceivesCopy" "NoAction"

Actions for contact to participate in.

NeedsToSign: Contact will will receive an email containing a document needing to be signed

ReceivesCopy: Contact to receive a copy of Signed Documents once signing is complete

No Action: Contact needs not further action

type
required
string
Enum: "Broker" "Buyer" "BuyerAgent" "BuyersLawyer" "EscrowOfficer" "LoanOfficer" "Other" "Seller" "SellerAgent" "SellersLawyer" "TitleOfficer"

The role that a contact has been assigned.

isEntity
boolean

Evaluates to true if the contact is an entity.

isUser
boolean

Evaluates to true if the contact is the also the agent (self).

firstName
required
string

The first name of the contact.

middleName
string

The middle name of the contact.

lastName
required
string

The last name of the contact.

suffix
string

The suffix of the contact.

email
string

The email of the contact.

primaryPhoneNumber
string

The primary phone number of the contact.

brokeragePhoneNumber
string

The brokerage phone number of the contact.

faxPhoneNumber
string

The fax phone number of the contact.

object

The primary address of the contact.

companyName
string

The company name that the contact belongs to.

agentLicenseNumber
string

The agent license number of the contact.

agentMLSCode
string

The agent mls code of the contact.

brokerLicenseNumber
string

The broker license number of the contact.

brokerMLSCode
string

The broker mls code of the contact.

brokerageLicenseNumber
string

The brokerage license number of the contact.

brokerageMLSCode
string

The brokerage mls code of the contact.

lenderLicenseNumber
string

The lender license number of the contact.

Responses

Request samples

Content type
application/json
{
  • "actionAttribute": "Empty",
  • "type": "Broker",
  • "isEntity": true,
  • "isUser": true,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "suffix": "string",
  • "email": "string",
  • "primaryPhoneNumber": "string",
  • "brokeragePhoneNumber": "string",
  • "faxPhoneNumber": "string",
  • "primaryAddress": {
    },
  • "companyName": "string",
  • "agentLicenseNumber": "string",
  • "agentMLSCode": "string",
  • "brokerLicenseNumber": "string",
  • "brokerMLSCode": "string",
  • "brokerageLicenseNumber": "string",
  • "brokerageMLSCode": "string",
  • "lenderLicenseNumber": "string"
}

Response samples

Content type
application/json
{
  • "contactId": 123456
}

Add Contacts to File

Add one or more contacts to a file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer >= 1

The id of the file to add the contacts to.

Request Body schema: application/json

The body of the request to add multiple contacts to a file.

Array of objects

The contacts to add to the file.

Responses

Request samples

Content type
application/json
{
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "totalRecordsAdded": 3
}

Delete Contact from File.

Delete a contact from a file.

REQUIRED SCOPES:
forms.files

path Parameters
contactId
required
integer >= 1

The id of the contact to delete.

fileId
required
integer >= 1

The id of the file to delete the contact from.

Responses

Response samples

Content type
application/json
{
  • "contactId": 123456
}

Documents

Get Signed Documents

Retrieve the signed documents for a file.

REQUIRED SCOPES:
forms.documents
forms.documents.read

path Parameters
fileId
required
integer >= 1

The id of the file to retrieve signed documents for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subscribe To Signed Documents Webhook

Subscribe a file to the signed documents webhook.

REQUIRED SCOPES:
forms.webhooks

path Parameters
fileId
required
integer >= 1

The id of the file to subscribe to the signed documents webhook.

Request Body schema: application/json
required
webhookUrl
required
string

The url to send the webhook response to when documents are signed documents.

Responses

Request samples

Content type
application/json
{
  • "webhookUrl": "string"
}

Response samples

Content type
application/json
{
  • "subscribed": true
}

Delete Document.

Delete a document.

REQUIRED SCOPES:
forms.documents

path Parameters
documentId
required
integer >= 1

The id of the document to delete.

Responses

Response samples

Content type
application/json
{
  • "documentId": 123456
}

Add Documents to File

Add one or more documents to a file.

REQUIRED SCOPES:
forms.files
forms.documents

path Parameters
fileId
required
integer >= 1

The id of the file to add the documents to.

Request Body schema: application/json
required
formIds
required
Array of integers non-empty

An array of the Form Ids of the Forms to add to the file.

Responses

Request samples

Content type
application/json
{
  • "formIds": [
    ]
}

Response samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Webhooks

Subscribe To Signed Documents Webhook

Subscribe a file to the signed documents webhook.

REQUIRED SCOPES:
forms.webhooks

path Parameters
fileId
required
integer >= 1

The id of the file to subscribe to the signed documents webhook.

Request Body schema: application/json
required
webhookUrl
required
string

The url to send the webhook response to when documents are signed documents.

Responses

Request samples

Content type
application/json
{
  • "webhookUrl": "string"
}

Response samples

Content type
application/json
{
  • "subscribed": true
}

Envelopes

Get Envelopes in File

Get the envelopes associated with a file.

REQUIRED SCOPES:
forms.files
forms.files.read

path Parameters
fileId
required
integer >= 1

The id of the file to retrieve envelopes for.

query Parameters
page
integer >= 1
Default: 1

The page number to retrieve.

pageSize
integer [ 1 .. 500 ]
Default: 10

The number of files returned per page.

filters
string

A sieve filter to that will be applied to the results.

sorts
string

A sieve list of sort fields to sort the results by.

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 0,
  • "envelopes": [
    ]
}

Create Envelope in File

Create an envelope for a file.

REQUIRED SCOPES:
forms.files

path Parameters
fileId
required
integer >= 1

The id of the file to add the envelope to.

Request Body schema: application/json
required
envelopeName
required
string

The name of the envelope to add to the file.

documentIds
required
Array of numbers

An array of the ids of the documents to add to the envelope.

Responses

Request samples

Content type
application/json
{
  • "envelopeName": "string",
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "fileId": 539181,
  • "envelope": {
    }
}

Forms

Get Forms

Get all of the Forms that the currently authenticated user has access to.

REQUIRED SCOPES:
forms.forms.read

query Parameters
libraryIds
Array of integers

Supply an array of library ids to filter the forms by. NOTE: If a libraryId is provided that the current user does not have access to, it will be ignored.

page
integer >= 1
Default: 1

The page number to retrieve.

pageSize
integer >= 1
Default: 10

The number of forms returned per page.

Responses

Response samples

Content type
application/json
{}

Users

Get User Profile

Retrieve the user profile of the currently authenticated user

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "subscriberId": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "suffix": "string",
  • "email": "string",
  • "primaryPhoneNumber": "string",
  • "brokerageName": "string",
  • "brokerageAddress": {
    },
  • "brokeragePhone": "string",
  • "brokerageFax": "string",
  • "regions": [
    ],
  • "libraries": [
    ],
  • "authProfiles": [
    ],
  • "isInitialized": true,
  • "termAcceptanceDate": "string",
  • "mlsCode": "string",
  • "licenseNumber": "string",
  • "brokerageLicenseNumber": "string",
  • "brokerageMLSCode": "string",
  • "isAutoDeletePreDraftEnvelopeAllowed": true,
  • "isAutoDeleteFormAllowed": true,
  • "consentedAssociations": [
    ],
  • "userPreferences": {
    },
  • "location": "string",
  • "createdOn": "string",
  • "createdBy": "string",
  • "updatedOn": "string",
  • "updatedBy": "string"
}

Libraries

Get Form Tags

Retrieve the tags that are associated with the forms.

REQUIRED SCOPES:
forms.forms.read

query Parameters
ids
string

The form version ids to retrieve tags for.

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 2,
  • "records": [
    ]
}

Get Libraries *

Retrieve the libraries that the user has access to.

REQUIRED SCOPES:
forms.libraries.read

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Library Forms *

Retrieve the forms that belong to the library.

REQUIRED SCOPES:
forms.libraries.read

path Parameters
libraryId
required
integer >= 1

The id of the library to retrieve forms for.

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 2,
  • "forms": [
    ]
}

Buyer Agreements

Get Buyer Agreements By Market

Retrieve the buyer agreements for a specific market.

REQUIRED SCOPES:
forms.buyerAgreements.restrictedRead

query Parameters
filters
string

A sieve list of filters that will be applied to the results.

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 1,
  • "files": [
    ]
}