openapi: 3.1.3
info:
x-logo:
url: https://s3.amazonaws.com/cdn.skyslope.com/forms/forms-logo-w-top-padding.png
href: https://skyslope.com/
altText: SkySlope
title: SkySlope Partnership API Reference
version: 1.0.0
description: "# Introduction\n The SkySlope Forms API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).\n\
\ Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded\
\ responses,\n and uses standard HTTP response codes, authentication, and verbs.
\n NOTE:\
\ Endpoints marked with an asterisk (*) will be available to our partners in the near future.\n #\
\ Authentication\n This API uses [OAuth 2.0 authorization code flow](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/)\n\
\ to obtain an access token that can be used to authenticate subsequent API requests.\n ## Access\
\ Tokens\n ### Request\n To obtain an access token, first redirect the user to the authorization\
\ endpoint:\n ```\n https://accounts.skyslope.com/oauth2/authorize?\n response_type=code\n \
\ &client_id={YOUR_CLIENT_ID}\n &redirect_uri={YOUR_REDIRECT_URI}\n &scope=forms.files\n \
\ &state={RANDOM_STATE_VALUE}\n &code_challenge={CODE_CHALLENGE}\n &code_challenge_method=S256\n\
\ ```\n After the user authorizes your application, they'll be redirected back to your redirect\
\ URI with an authorization code.\n Exchange this code for an access token by making a POST request\
\ to the token endpoint:\n ```\n POST /oauth2/token HTTP/1.1\n Host: accounts.skyslope.com\n Content-Type:\
\ application/x-www-form-urlencoded\n \n grant_type=authorization_code\n &client_id={YOUR_CLIENT_ID}\n\
\ &client_secret={YOUR_CLIENT_SECRET}\n &code={AUTHORIZATION_CODE}\n &redirect_uri={YOUR_REDIRECT_URI}\n\
\ &code_verifier={CODE_VERIFIER}\n ```\n ### Usage\n Authentication to the API is performed by\
\ including your access token in the **Authorization** header of your\n API requests with the Bearer\
\ authentication scheme:\n ```\n GET /partner/api/files HTTP/1.1\n Host: forms.skyslope.com\n \
\ Authorization: Bearer {YOUR_ACCESS_TOKEN}\n ```\n All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS).\
\ Calls made over plain HTTP will fail.\n API requests without authentication will also fail.\n \
\ ## Refresh Tokens\n Refresh tokens allow you to obtain new access tokens without requiring the\
\ user to re-authenticate. When you first\n complete the OAuth flow, you'll receive both an access\
\ token and a refresh token.\n ### Request\n To receive a refresh token, include the `offline_access`\
\ scope in your initial authorization request:\n ```\n https://accounts.skyslope.com/oauth2/authorize?\n\
\ response_type=code\n &client_id={YOUR_CLIENT_ID}\n &scope=forms.files offline_access\n\
\ &redirect_uri={YOUR_REDIRECT_URI}\n ```\n ### Usage\n When your access token expires, make\
\ a POST request to the token endpoint:\n ```\n POST /oauth2/token HTTP/1.1\n Host: accounts.skyslope.com\n\
\ Content-Type: application/x-www-form-urlencoded\n \n grant_type=refresh_token\n &client_id={YOUR_CLIENT_ID}\n\
\ &client_secret={YOUR_CLIENT_SECRET}\n &refresh_token={YOUR_REFRESH_TOKEN}\n ```\n This will\
\ return a new access token and refresh token pair.\n ### Security Best Practices\n - Store refresh\
\ tokens securely on your backend server, never on client side\n - Encrypt refresh tokens at rest\
\ using strong encryption\n - Rotate refresh token on each use\n - Set up monitoring for unusual\
\ refresh token usage patterns\n - If a refresh token is compromised, revoke it immediately using\
\ the token revocation endpoint\n - Implement automatic cleanup of unused refresh tokens"
termsOfService: https://skyslope.com/terms-conditions/
contact:
name: Support
url: https://support.skyslope.com/hc/en-us
email: support@skyslope.com
components:
schemas: {}
paths:
/files:
post:
summary: Create Listing or Transaction File
tags:
- Files
description: 'Creates a listing or a transaction file and returns the file id.REQUIRED
SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
name:
type: string
description: The name of the file.
representationType:
type: string
enum:
- Buyer
- Seller
- Tenant
- Landlord
description: The representation type of the file.
property:
type: object
description: The property that the file is associated with.
additionalProperties: false
properties:
streetNumber:
type: string
description: The street number of the property.
streetName:
type: string
description: The street name of the property.
unitNumber:
type: string
description: The unit number of the property.
city:
type: string
description: The city of the property.
state:
type: string
description: The abbreviation for the state/province of the property.
minLength: 2
maxLength: 2
postalCode:
type: string
description: The postal code of the property.
county:
type: string
description: The county of the property.
required:
- streetNumber
- streetName
- city
- state
- postalCode
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
fileId:
type: number
description: The id of the file that was created.
example:
fileId: 477309
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
get:
summary: Get Files
tags:
- Files
description: 'Retrieve the files that the user has access to.REQUIRED SCOPES:
forms.files
forms.files.read
REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
name:
type: string
description: The name of the file.
fileData:
type: object
description: File data that can be updated.
additionalProperties: true
properties:
mlsNumber:
type: string
description: The mls number of the file.
purchasePrice:
type: number
description: The purchase price of the property.
closingDate:
type: string
description: The closing date of the file in the format of YYYY-MM-DDTHH:MM:SSZ.
acceptanceDate:
type: string
description: The acceptanced date of the file in the format of YYYY-MM-DDTHH:MM:SSZ.
premisesAddress:
type: object
description: The property that the file is associated with.
additionalProperties: false
properties:
streetNumber:
type: string
description: The street number of the property.
streetName:
type: string
description: The street name of the property.
unitNumber:
type: string
description: The unit number of the property.
city:
type: string
description: The city of the property.
state:
type: string
description: The abbreviation for the state/province of the property.
minLength: 2
maxLength: 2
postalCode:
type: string
description: The postal code of the property.
county:
type: string
description: The county of the property.
required:
- streetNumber
- streetName
- city
- state
- postalCode
parameters:
- schema:
type: integer
in: path
name: fileId
required: true
description: The id of the file to update.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
fileId:
type: number
description: The id of the file that was updated.
didAddendumsChange:
type: boolean
description: Evaluates to true if addendums were changed.
example:
fileId: 477309
didAddendumsChange: false
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
put:
summary: Update File
tags:
- Files
description: 'Update the file of a listing or transaction file.REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- property
- commissions
- contacts
properties:
mlsNumber:
type: string
description: The mls number of the file.
purchasePrice:
type: number
description: The purchase price of the property.
closingDateTime:
type: string
description: The closing date of the file in the format of YYYY-MM-DDTHH:MM:SSZ.
acceptanceDateTime:
type: string
description: The acceptanced date of the file in the format of YYYY-MM-DDTHH:MM:SSZ.
property:
type: object
description: The property that the file is associated with.
additionalProperties: false
properties:
streetNumber:
type: string
description: The street number of the property.
streetName:
type: string
description: The street name of the property.
unitNumber:
type: string
description: The unit number of the property.
city:
type: string
description: The city of the property.
state:
type: string
description: The abbreviation for the state/province of the property.
minLength: 2
maxLength: 2
postalCode:
type: string
description: The postal code of the property.
county:
type: string
description: The county of the property.
required:
- streetNumber
- streetName
- city
- state
- postalCode
commissions:
type: array
description: An array of the commissions for the file.
items:
type: object
properties:
id:
type: string
description: The id of the commission.
type:
type: string
enum:
- Listing
- Referral
- Sale
description: The type of the commission.
calculationType:
type: string
enum:
- Flat
- Percent
description: The calculation type of the commission.
amount:
type: number
description: The amount of the commission.
createdBy:
type: string
description: The id of the user who created the commission.
updatedBy:
type: string
description: The id of the user who last updated the commission.
createdOn:
type: string
description: The date and time the commission was created.
updatedOn:
type: string
description: The date and time the commission was last updated.
ownedBy:
type: string
description: The id of the user who owns the commission.
contacts:
type: array
description: An array of contacts for the file.
items:
type: object
additionalProperties: false
properties:
id:
type: string
description: The id of the contact.
type:
type: string
description: The role that a contact has been assigned.
enum:
- Broker
- Buyer
- BuyerAgent
- BuyersLawyer
- EscrowOfficer
- LoanOfficer
- Other
- Seller
- SellerAgent
- SellersLawyer
- TitleOfficer
actionAttribute:
type: string
description: Actions for contact to participate in.
enum:
- Empty
- NeedsToSign
- CanView
- ReceivesCopy
- NoAction
firstName:
type: string
description: The first name of the contact.
middleName:
type: string
description: The middle name of the contact.
lastName:
type: string
description: The last name of the contact.
suffix:
type: string
description: The suffix of the contact.
email:
type: string
description: The email of the contact.
primaryPhoneNumber:
type: string
description: The primary phone number of the contact.
brokeragePhoneNumber:
type: string
description: The brokerage phone number of the contact.
faxPhoneNumber:
type: string
description: The fax phone number of the contact.
companyName:
type: string
description: The company name that the contact belongs to.
isEntity:
type: boolean
description: Evaluates to true if the contact is an entity.
isUser:
type: boolean
description: Evaluates to true if the contact is the also the agent (self).
isFileOwner:
type: boolean
description: Evaluates to true if the contact is the file owner.
lenderLicenseNumber:
type: string
description: The lender license number of the contact.
agentLicenseNumber:
type: string
description: The agent license number of the contact.
agentMLSCode:
type: string
description: The agent mls code of the contact.
brokerLicenseNumber:
type: string
description: The broker license number of the contact.
brokerMLSCode:
type: string
description: The broker mls code of the contact.
brokerageLicenseNumber:
type: string
description: The brokerage license number of the contact.
brokerageMLSCode:
type: string
description: The brokerage mls code of the contact.
primaryAddress:
type: object
description: The primary address of the contact.
additionalProperties: false
properties:
streetNumber:
type: string
description: The street number of the property.
streetName:
type: string
description: The street name of the property.
unitNumber:
type: string
description: The unit number of the property.
city:
type: string
description: The city of the property.
state:
type: string
description: The abbreviation for the state/province of the property.
minLength: 2
maxLength: 2
postalCode:
type: string
description: The postal code of the property.
county:
type: string
description: The county of the property.
required:
- streetNumber
- streetName
- city
- state
- postalCode
contactInformation:
type: object
description: An object containing all of the contact information for the contact.
additionalProperties: true
required: true
parameters:
- schema:
type: integer
in: path
name: fileId
required: true
description: The id of the file to update.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
fileId:
type: number
description: The id of the file that was updated.
commissions:
type: array
description: An array of the commissions for the file.
items:
type: object
properties:
id:
type: string
description: The id of the commission.
type:
type: string
enum:
- Listing
- Referral
- Sale
description: The type of the commission.
calculationType:
type: string
enum:
- Flat
- Percent
description: The calculation type of the commission.
amount:
type: number
description: The amount of the commission.
createdBy:
type: string
description: The id of the user who created the commission.
updatedBy:
type: string
description: The id of the user who last updated the commission.
createdOn:
type: string
description: The date and time the commission was created.
updatedOn:
type: string
description: The date and time the commission was last updated.
ownedBy:
type: string
description: The id of the user who owns the commission.
contacts:
type: array
description: An array of contacts for the file.
items:
type: object
additionalProperties: false
properties:
id:
type: string
description: The id of the contact.
type:
type: string
description: The role that a contact has been assigned.
enum:
- Broker
- Buyer
- BuyerAgent
- BuyersLawyer
- EscrowOfficer
- LoanOfficer
- Other
- Seller
- SellerAgent
- SellersLawyer
- TitleOfficer
actionAttribute:
type: string
description: Actions for contact to participate in.
enum:
- Empty
- NeedsToSign
- CanView
- ReceivesCopy
- NoAction
firstName:
type: string
description: The first name of the contact.
middleName:
type: string
description: The middle name of the contact.
lastName:
type: string
description: The last name of the contact.
suffix:
type: string
description: The suffix of the contact.
email:
type: string
description: The email of the contact.
primaryPhoneNumber:
type: string
description: The primary phone number of the contact.
brokeragePhoneNumber:
type: string
description: The brokerage phone number of the contact.
faxPhoneNumber:
type: string
description: The fax phone number of the contact.
companyName:
type: string
description: The company name that the contact belongs to.
isEntity:
type: boolean
description: Evaluates to true if the contact is an entity.
isUser:
type: boolean
description: Evaluates to true if the contact is the also the agent (self).
isFileOwner:
type: boolean
description: Evaluates to true if the contact is the file owner.
lenderLicenseNumber:
type: string
description: The lender license number of the contact.
agentLicenseNumber:
type: string
description: The agent license number of the contact.
agentMLSCode:
type: string
description: The agent mls code of the contact.
brokerLicenseNumber:
type: string
description: The broker license number of the contact.
brokerMLSCode:
type: string
description: The broker mls code of the contact.
brokerageLicenseNumber:
type: string
description: The brokerage license number of the contact.
brokerageMLSCode:
type: string
description: The brokerage mls code of the contact.
primaryAddress:
type: object
description: The primary address of the contact.
additionalProperties: false
properties:
streetNumber:
type: string
description: The street number of the property.
streetName:
type: string
description: The street name of the property.
unitNumber:
type: string
description: The unit number of the property.
city:
type: string
description: The city of the property.
state:
type: string
description: The abbreviation for the state/province of the property.
minLength: 2
maxLength: 2
postalCode:
type: string
description: The postal code of the property.
county:
type: string
description: The county of the property.
required:
- streetNumber
- streetName
- city
- state
- postalCode
contactInformation:
type: object
description: An object containing all of the contact information for the contact.
additionalProperties: true
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
get:
summary: Get File
tags:
- Files
description: 'Retrieve the details of a listing or transaction file.REQUIRED SCOPES:
forms.files
forms.files.read
REQUIRED SCOPES:
forms.templates.read
forms.files.read
forms.files
REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
description: The body of the request to add a contact to a file.
required:
- firstName
- lastName
- type
additionalProperties: false
properties:
actionAttribute:
type: string
enum:
- Empty
- NeedsToSign
- CanView
- ReceivesCopy
- NoAction
description: "Actions for contact to participate in.\n
NeedsToSign:\
\ Contact will will receive an email containing a document needing to be signed\n\
ReceivesCopy: Contact to receive a copy of Signed Documents\
\ once signing is complete
No Action: Contact needs not further\
\ action
"
type:
type: string
enum:
- Broker
- Buyer
- BuyerAgent
- BuyersLawyer
- EscrowOfficer
- LoanOfficer
- Other
- Seller
- SellerAgent
- SellersLawyer
- TitleOfficer
description: The role that a contact has been assigned.
isEntity:
type: boolean
description: Evaluates to true if the contact is an entity.
isUser:
type: boolean
description: Evaluates to true if the contact is the also the agent (self).
firstName:
type: string
description: The first name of the contact.
middleName:
type: string
description: The middle name of the contact.
lastName:
type: string
description: The last name of the contact.
suffix:
type: string
description: The suffix of the contact.
email:
type: string
description: The email of the contact.
primaryPhoneNumber:
type: string
description: The primary phone number of the contact.
brokeragePhoneNumber:
type: string
description: The brokerage phone number of the contact.
faxPhoneNumber:
type: string
description: The fax phone number of the contact.
primaryAddress:
type: object
description: The primary address of the contact.
additionalProperties: false
properties:
streetNumber:
type: string
description: The street number of the property.
streetName:
type: string
description: The street name of the property.
unitNumber:
type: string
description: The unit number of the property.
city:
type: string
description: The city of the property.
state:
type: string
description: The abbreviation for the state/province of the property.
minLength: 2
maxLength: 2
postalCode:
type: string
description: The postal code of the property.
county:
type: string
description: The county of the property.
required:
- streetNumber
- streetName
- city
- state
- postalCode
companyName:
type: string
description: The company name that the contact belongs to.
agentLicenseNumber:
type: string
description: The agent license number of the contact.
agentMLSCode:
type: string
description: The agent mls code of the contact.
brokerLicenseNumber:
type: string
description: The broker license number of the contact.
brokerMLSCode:
type: string
description: The broker mls code of the contact.
brokerageLicenseNumber:
type: string
description: The brokerage license number of the contact.
brokerageMLSCode:
type: string
description: The brokerage mls code of the contact.
lenderLicenseNumber:
type: string
description: The lender license number of the contact.
required: true
description: The body of the request to add a contact to a file.
parameters:
- schema:
type: integer
minimum: 1
in: path
name: fileId
required: true
description: The id of the file to add the contact to.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
contactId:
type: number
description: The id of the contact that was added to the file.
example:
contactId: 123456
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/files/contacts/{contactId}:
put:
summary: Update Contact in File.
tags:
- Files
- Contacts
description: 'Update a contact in a file.REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
description: The body of the request to add a contact to a file.
required:
- firstName
- lastName
- type
additionalProperties: false
properties:
actionAttribute:
type: string
enum:
- Empty
- NeedsToSign
- CanView
- ReceivesCopy
- NoAction
description: "Actions for contact to participate in.\n
NeedsToSign:\
\ Contact will will receive an email containing a document needing to be signed\n\
ReceivesCopy: Contact to receive a copy of Signed Documents\
\ once signing is complete
No Action: Contact needs not further\
\ action
"
type:
type: string
enum:
- Broker
- Buyer
- BuyerAgent
- BuyersLawyer
- EscrowOfficer
- LoanOfficer
- Other
- Seller
- SellerAgent
- SellersLawyer
- TitleOfficer
description: The role that a contact has been assigned.
isEntity:
type: boolean
description: Evaluates to true if the contact is an entity.
isUser:
type: boolean
description: Evaluates to true if the contact is the also the agent (self).
firstName:
type: string
description: The first name of the contact.
middleName:
type: string
description: The middle name of the contact.
lastName:
type: string
description: The last name of the contact.
suffix:
type: string
description: The suffix of the contact.
email:
type: string
description: The email of the contact.
primaryPhoneNumber:
type: string
description: The primary phone number of the contact.
brokeragePhoneNumber:
type: string
description: The brokerage phone number of the contact.
faxPhoneNumber:
type: string
description: The fax phone number of the contact.
primaryAddress:
type: object
description: The primary address of the contact.
additionalProperties: false
properties:
streetNumber:
type: string
description: The street number of the property.
streetName:
type: string
description: The street name of the property.
unitNumber:
type: string
description: The unit number of the property.
city:
type: string
description: The city of the property.
state:
type: string
description: The abbreviation for the state/province of the property.
minLength: 2
maxLength: 2
postalCode:
type: string
description: The postal code of the property.
county:
type: string
description: The county of the property.
required:
- streetNumber
- streetName
- city
- state
- postalCode
companyName:
type: string
description: The company name that the contact belongs to.
agentLicenseNumber:
type: string
description: The agent license number of the contact.
agentMLSCode:
type: string
description: The agent mls code of the contact.
brokerLicenseNumber:
type: string
description: The broker license number of the contact.
brokerMLSCode:
type: string
description: The broker mls code of the contact.
brokerageLicenseNumber:
type: string
description: The brokerage license number of the contact.
brokerageMLSCode:
type: string
description: The brokerage mls code of the contact.
lenderLicenseNumber:
type: string
description: The lender license number of the contact.
required: true
description: The body of the request to add a contact to a file.
parameters:
- schema:
type: integer
minimum: 1
in: path
name: contactId
required: true
description: The id of the contact to update.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
contactId:
type: number
description: The id of the contact that was added to the file.
example:
contactId: 123456
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/files/{fileId}/contacts/bulk:
post:
summary: Add Contacts to File
tags:
- Files
- Contacts
description: 'Add one or more contacts to a file.REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
description: The body of the request to add multiple contacts to a file.
properties:
contacts:
type: array
description: The contacts to add to the file.
items:
type: object
description: The body of the request to add a contact to a file.
required:
- firstName
- lastName
- type
additionalProperties: false
properties:
actionAttribute:
type: string
enum:
- Empty
- NeedsToSign
- CanView
- ReceivesCopy
- NoAction
description: "Actions for contact to participate in.\n
NeedsToSign:\
\ Contact will will receive an email containing a document needing to be signed\n\
ReceivesCopy: Contact to receive a copy of Signed Documents\
\ once signing is complete
No Action: Contact needs not\
\ further action
"
type:
type: string
enum:
- Broker
- Buyer
- BuyerAgent
- BuyersLawyer
- EscrowOfficer
- LoanOfficer
- Other
- Seller
- SellerAgent
- SellersLawyer
- TitleOfficer
description: The role that a contact has been assigned.
isEntity:
type: boolean
description: Evaluates to true if the contact is an entity.
isUser:
type: boolean
description: Evaluates to true if the contact is the also the agent (self).
firstName:
type: string
description: The first name of the contact.
middleName:
type: string
description: The middle name of the contact.
lastName:
type: string
description: The last name of the contact.
suffix:
type: string
description: The suffix of the contact.
email:
type: string
description: The email of the contact.
primaryPhoneNumber:
type: string
description: The primary phone number of the contact.
brokeragePhoneNumber:
type: string
description: The brokerage phone number of the contact.
faxPhoneNumber:
type: string
description: The fax phone number of the contact.
primaryAddress:
type: object
description: The primary address of the contact.
additionalProperties: false
properties:
streetNumber:
type: string
description: The street number of the property.
streetName:
type: string
description: The street name of the property.
unitNumber:
type: string
description: The unit number of the property.
city:
type: string
description: The city of the property.
state:
type: string
description: The abbreviation for the state/province of the property.
minLength: 2
maxLength: 2
postalCode:
type: string
description: The postal code of the property.
county:
type: string
description: The county of the property.
required:
- streetNumber
- streetName
- city
- state
- postalCode
companyName:
type: string
description: The company name that the contact belongs to.
agentLicenseNumber:
type: string
description: The agent license number of the contact.
agentMLSCode:
type: string
description: The agent mls code of the contact.
brokerLicenseNumber:
type: string
description: The broker license number of the contact.
brokerMLSCode:
type: string
description: The broker mls code of the contact.
brokerageLicenseNumber:
type: string
description: The brokerage license number of the contact.
brokerageMLSCode:
type: string
description: The brokerage mls code of the contact.
lenderLicenseNumber:
type: string
description: The lender license number of the contact.
description: The body of the request to add multiple contacts to a file.
parameters:
- schema:
type: integer
minimum: 1
in: path
name: fileId
required: true
description: The id of the file to add the contacts to.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
totalRecordsAdded:
type: number
description: The total number of contacts that were added to the file.
example:
totalRecordsAdded: 3
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/files/{fileId}/contacts/{contactId}:
delete:
summary: Delete Contact from File.
tags:
- Files
- Contacts
description: 'Delete a contact from a file.REQUIRED SCOPES:
'
parameters:
- schema:
type: integer
minimum: 1
in: path
name: contactId
required: true
description: The id of the contact to delete.
- schema:
type: integer
minimum: 1
in: path
name: fileId
required: true
description: The id of the file to delete the contact from.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- contactId
properties:
contactId:
type: number
description: The id of the contact that was deleted from the file.
example:
contactId: 123456
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/documents/{documentId}:
get:
summary: Get Document
tags:
- Documents
description: 'Retrieve the details and field definitions for a document by its id.REQUIRED
SCOPES:
forms.documents
forms.documents.read
REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
description: A JSON object containing the document field data references and their values
to be updated. Only the fields supplied will be updated; existing values of other fields
are preserved.
description: A JSON object containing the document field data references and their values to be
updated. Only the fields supplied will be updated; existing values of other fields are preserved.
parameters:
- schema:
type: integer
minimum: 1
in: path
name: documentId
required: true
description: The id of the document to update.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
documentId:
type: number
description: The id of the document that was updated.
didAddendumsChange:
type: boolean
description: Evaluates to true if the number of addendum pages changed as a result
of the update.
example:
documentId: 123456
didAddendumsChange: false
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
delete:
summary: Delete Document.
tags:
- Documents
description: 'Delete a document.REQUIRED SCOPES:
'
parameters:
- schema:
type: integer
minimum: 1
in: path
name: documentId
required: true
description: The id of the document to delete.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- documentId
properties:
documentId:
type: number
description: The id of the document that was deleted from the file.
example:
documentId: 123456
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/files/{fileId}/documents:
get:
summary: Get File Documents
tags:
- Documents
- Files
description: 'Retrieve the documents metadata for a file. To download documents with proper branding
and data stamping, use the /files/:fileId/documents/download or /files/:fileId/documents/download/pdf
endpoints.REQUIRED SCOPES:
forms.documents
forms.documents.read
REQUIRED SCOPES:
forms.files
forms.documents
REQUIRED SCOPES:
forms.documents
forms.documents.read
REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- webhookUrl
properties:
webhookUrl:
type: string
description: The url to send the webhook response to when documents are signed documents.
required: true
parameters:
- schema:
type: integer
minimum: 1
in: path
name: fileId
required: true
description: The id of the file to subscribe to the signed documents webhook.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
subscribed:
type: boolean
description: Evaluates to true if the user was successfully subscribed to the webhook.
'208':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/files/{fileId}/envelopes:
get:
summary: Get Envelopes in File
tags:
- Envelopes
- Files
description: 'Get the envelopes associated with a file.REQUIRED SCOPES:
forms.files
forms.files.read
REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- envelopeName
- documentIds
properties:
envelopeName:
type: string
description: The name of the envelope to add to the file.
documentIds:
type: array
description: An array of the ids of the documents to add to the envelope.
items:
type: number
required: true
parameters:
- schema:
type: integer
minimum: 1
in: path
name: fileId
required: true
description: The id of the file to add the envelope to.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
fileId:
type: number
description: The id of the file that the envelope was added to.
envelope:
type: object
description: The envelope that was added to the file.
additionalProperties: false
properties:
id:
type: string
description: The id of the envelope that was added to the file.
name:
type: string
description: The name of the envelope.
example:
fileId: 539181
envelope:
id: 115682
name: My Envelope Name
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/forms:
get:
summary: Get Forms
tags:
- Forms
description: 'Get all of the Forms that the currently authenticated user has access to.REQUIRED
SCOPES:
'
parameters:
- schema:
type: array
items:
type: integer
in: query
name: libraryIds
required: false
description: '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.'
- schema:
type: integer
minimum: 1
default: 1
in: query
name: page
required: false
description: The page number to retrieve.
- schema:
type: integer
minimum: 1
default: 10
in: query
name: pageSize
required: false
description: The number of forms returned per page.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
totalRecords:
type: number
description: The total number of forms found for the authenticated user.
forms:
type: array
description: An array of the forms that the user has access to.
items:
type: object
properties:
formId:
type: number
description: The form id of the form.
libraryId:
type: number
description: The library id of the form.
name:
type: string
description: The name of the form.
pageCount:
type: number
description: The number of pages in the form.
url:
type: string
description: The url of the form.
previewUrl:
type: string
description: The preview url of the form.
thumbnailUrl:
type: string
description: The thumbnail url of the form.
createdOn:
type: string
description: The date and time the form was created.
updatedOn:
type: string
description: The date and time the form was last updated.
source:
type: string
description: The source of the form.
sources:
type: array
description: An array of sources for the form.
items:
type: string
attributes:
type: object
description: An object containing the tags associated with the form.
additionalProperties: true
example:
totalRecords: 2
forms:
- id: 36095
name: Agreement Notice to Short Sale Addendum (Short Sale)
libraryId: 14289
attributes:
form-type: BRBC
- id: 40144
name: BRBC Buyer Representation And Broker Compensation Agreement
libraryId: 14289
attributes:
form-type: BRBC
nextLink: https://forms.skyslope.com/library/api/forms?filter=libraryId==13456&formName=Buyer&orderBy=FormName&page=2&pageSize=10
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/users/profile:
get:
summary: Get User Profile
tags:
- Users
description: Retrieve the user profile of the currently authenticated user
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the user who belongs to the profile.
subscriberId:
type: string
description: The subscriber id of the user.
firstName:
type: string
description: The first name of the user.
middleName:
type: string
description: The middle name of the user.
lastName:
type: string
description: The last name of the user.
suffix:
type: string
description: The suffix of the user.
email:
type: string
description: The email of the user.
primaryPhoneNumber:
type: string
description: The primary phone number of the user.
brokerageName:
type: string
description: The name of the brokerage that the user belongs to.
brokerageAddress:
type: object
description: The address of the brokerage that the user belongs to.
properties:
streetAddress:
type: string
description: The street address of the brokerage.
unitNumber:
type: string
description: The unit number of the brokerage.
city:
type: string
description: The city of the brokerage.
state:
type: string
description: The state of the brokerage.
postalCode:
type: string
description: The postal code of the brokerage.
county:
type: string
description: The county of the brokerage.
brokeragePhone:
type: string
description: The phone number of the brokerage that the user belongs to.
brokerageFax:
type: string
description: The fax number of the brokerage that the user belongs to.
regions:
type: array
description: An array of regions that the user has access to.
items:
type: object
properties:
country:
type: string
region:
type: string
libraries:
type: array
description: An array of libraries that the user has access to.
items:
type: number
authProfiles:
type: array
description: An array of the auth profiles of the user.
items:
additionalFields: true
isInitialized:
type: boolean
description: Evaluates to true if the user profile has been on-boarded.
termAcceptanceDate:
type: string
description: The date and time the user accepted the terms.
mlsCode:
type: string
description: The mls code of the user.
licenseNumber:
type: string
description: The license number of the user.
brokerageLicenseNumber:
type: string
description: The license number of the brokerage that the user belongs to.
brokerageMLSCode:
type: string
description: The mls code of the brokerage that the user belongs to.
isAutoDeletePreDraftEnvelopeAllowed:
type: boolean
description: Evaluates to true if auto delete pre draft envelopes is enabled.
isAutoDeleteFormAllowed:
type: boolean
description: Evaluates to true if auto delete forms is enabled.
consentedAssociations:
type: array
description: An array of the consented associations for the user.
items:
type: string
userPreferences:
type: object
properties:
digitalSigningPlatformPreference:
type: string
description: The digital signing platform preference of the user.
nhdProviderPreference:
type: string
description: The nhd provider preference of the user.
location:
type: string
description: The location of the user.
createdOn:
type: string
description: The date and time the user profile was created.
createdBy:
type: string
description: The id of the user who created the user profile.
updatedOn:
type: string
description: The date and time the user profile was last updated.
updatedBy:
type: string
description: The id of the user who last updated the user profile.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/group:
post:
summary: Add Group
tags:
- Users
description: 'Create a new group via accounts-api.REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
properties:
brokerageId:
type: string
description: The brokerage id for the new group. If not provided, will be auto-generated
with prefix "partnerApi_".
brokerageName:
type: string
description: The name of the brokerage.
responses:
'200':
description: Group already exists.
content:
application/json:
schema:
type: object
properties:
groupId:
type: string
description: The id of the newly created group.
required:
- groupId
'201':
description: Group successfully created.
content:
application/json:
schema:
type: object
properties:
groupId:
type: string
description: The id of the newly created group.
required:
- groupId
'400':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
'401':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
'500':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/groups/{groupId}/child:
post:
summary: Add Child Group
tags:
- Users
description: 'Create a new child group for a parent group via accounts-api.REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
minLength: 1
description: The name of the child group.
required: true
parameters:
- schema:
type: string
minLength: 1
in: path
name: groupId
required: true
description: The id of the parent group.
responses:
'200':
description: Child group already exists for the parent group.
content:
application/json:
schema:
type: object
properties:
childGroupId:
type: string
description: The id of the newly created child group.
required:
- childGroupId
'201':
description: Child group successfully created.
content:
application/json:
schema:
type: object
properties:
childGroupId:
type: string
description: The id of the newly created child group.
required:
- childGroupId
'400':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
'401':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
'500':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/users/{userId}/groups/{groupId}:
post:
summary: Add Group to User
tags:
- Users
description: 'Add group to a user.REQUIRED SCOPES:
'
parameters:
- schema:
type: string
minLength: 1
in: path
name: userId
required: true
description: The id of the user to add to the group.
- schema:
type: string
minLength: 1
in: path
name: groupId
required: true
description: The id of the group to add the user to.
responses:
'204':
description: Group successfully added to user.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
delete:
summary: Remove User from Group
tags:
- Users
description: 'Remove a user from a group.REQUIRED SCOPES:
'
parameters:
- schema:
type: string
minLength: 1
in: path
name: userId
required: true
description: The id of the user to remove from the group.
- schema:
type: string
minLength: 1
in: path
name: groupId
required: true
description: The id of the group to remove the user from.
responses:
'204':
description: User successfully removed from group.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/tags:
get:
summary: Get Form Tags
tags:
- Libraries
description: 'Retrieve the tags that are associated with the forms.REQUIRED SCOPES:
'
parameters:
- schema:
type: string
in: query
name: ids
required: false
description: The form version ids to retrieve tags for.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
description: A response containing the tags.
properties:
totalRecords:
type: number
description: The total number of records.
records:
type: array
description: An array of the tags.
items:
type: object
properties:
id:
type: number
description: The id of the tag.
tags:
type: object
description: The tags object.
additionalProperties: true
example:
totalRecords: 2
records:
- id: 28576
tags:
form-type: residential-purchase-contract
- id: 29533
tags:
gives-ds3-access: 'true'
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/files/{fileId}/templates:
post:
summary: Apply Template to File
tags:
- Files
description: 'Apply a template to a file.REQUIRED SCOPES:
'
requestBody:
content:
application/json:
schema:
type: object
required:
- templateId
properties:
templateId:
type: integer
description: The id of the template to apply to the file.
required: true
parameters:
- schema:
type: integer
minimum: 1
in: path
name: fileId
required: true
description: The id of the file to apply the template to.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
fileId:
type: integer
description: The id of the file the template was applied to.
example:
fileId: 667309
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/buyer-agreements/market:
get:
summary: Get Buyer Agreements By Market
tags:
- Buyer Agreements
description: 'Retrieve the buyer agreements for a specific market.REQUIRED SCOPES:
forms.buyerAgreements.restrictedRead
REQUIRED SCOPES:
'
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- totalRecords
- libraries
properties:
totalRecords:
type: number
description: The total number of authorized libraries.
libraries:
type: array
items:
type: object
required:
- id
- name
- regionCodes
properties:
id:
type: integer
description: Library id
name:
type: string
description: Name of library
regionCodes:
type: array
items:
type: string
description: Serving Regions
description: An array of libraries the user is authorized to access.
description: A response containing the authorized libraries for the user.
example:
totalRecords: 1
libraries:
- id: 1551
name: Arizona Association of Realtors
regionCodes:
- US-AZ
- US-CA
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
/libraries/{libraryId}/form-versions:
get:
summary: Get Library Form Versions
tags:
- Libraries
description: 'Retrieve the form versions for a specific library.REQUIRED SCOPES:
'
parameters:
- schema:
type: integer
minimum: 1
in: path
name: libraryId
required: true
description: The id of the library to retrieve form versions for.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- totalRecords
- formVersions
properties:
totalRecords:
type: number
description: The total number of form versions.
formVersions:
type: array
items:
type: object
required:
- id
- formId
- name
- attributes
- publishedVersionId
- thumbnailUrl
properties:
id:
type: integer
description: Form version id
formId:
type: integer
description: A form has multiple versions, this is the id of the form that this
version belongs to.
name:
type: string
description: Form name
attributes:
type: object
description: Dynamic attributes object containing form metadata. All attributes
are optional and if present will be strings.
additionalProperties:
type: string
publishedVersionId:
type: integer
description: In the case that a newer version is published, this will be the
id of the newer version.
thumbnailUrl:
type: string
description: URL to form thumbnail image
description: An array of form versions from the specified library.
description: A response containing the form versions for a specific library.
example:
totalRecords: 5
formVersions:
- id: 36094
formId: 35345
name: Addendum Copy Test
attributes:
quickAction: delete
publishedVersionId: 36094
thumbnailUrl: url-here
- id: 36095
formId: 35931
name: BIC CAR TEST - FOO
attributes:
formType: BRBC
publishedVersionId: 36095
thumbnailUrl: url-here
- id: 41054
formId: 40355
name: BRBC - CRMLS testing
attributes:
formType: BRBC
isCarBRBC: 'true'
quickAction: BuyerAgreement
hasStartDate: 'true'
isCRMLSTracked: 'true'
publishedVersionId: 41054
thumbnailUrl: url-here
- id: 41063
formId: 40362
name: BRBC - CRMLS testing - no dates
attributes:
formType: BRBC
isCarBRBC: 'true'
quickAction: BuyerAgreement
hasStartDate: 'true'
isCRMLSTracked: 'true'
downloadWithoutAddress: 'true'
publishedVersionId: 41063
thumbnailUrl: url-here
- id: 41046
formId: 39761
name: BRBC Buyer Representation And Broker Compensation Agreement - CAR
attributes:
formType: BRBC
isCarBRBC: 'true'
quickAction: BuyerAgreement
QuickActions: BuyerAgreement
hasStartDate: 'true'
isCRMLSTracked: 'true'
publishedVersionId: 41046
thumbnailUrl: url-here
default:
description: Default Response
content:
application/json:
schema:
type: object
required:
- code
- message
- errors
- traceId
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
items:
type: string
description: An array of the errors that occurred.
traceId:
type: string
description: A request correlation ID.
/files/{fileId}/documents/download/pdf:
get:
summary: Download File Documents as PDF
tags:
- Files
description: 'Download one or more documents from a file as a combined PDF with file details stamped
on the documents. If the call is successful, the response will be a PDF file containing the requested
documents. If it is not successful, the response will be json containing the error.REQUIRED
SCOPES:
forms.files
forms.documents
REQUIRED SCOPES:
'
parameters:
- schema:
type: string
in: query
name: documentIds
required: true
description: 'Comma-separated list of document IDs to download. Single ID returns PDF, multiple
IDs return ZIP. Example: "123,456,789"'
- schema:
type: integer
minimum: 1
in: path
name: fileId
required: true
description: The id of the file to download documents from.
responses:
'200':
description: Document file - PDF for single document, ZIP for multiple documents
content:
application/pdf:
schema:
type: string
format: binary
application/zip:
schema:
type: string
format: binary
default:
description: Default Response
content:
application/json:
schema:
type: object
required:
- code
- message
- errors
- traceId
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
items:
type: string
description: An array of the errors that occurred.
traceId:
type: string
description: A request correlation ID.
/files/{fileId}/documents/upload:
post:
summary: Upload Document to File
tags:
- Files
- Documents
description: 'Upload a PDF document to a file. Max size 25MB. Accepts multipart/form-data with fields:
DocumentName (string), DocumentBody (binary PDF file), IsSignedDocument (true/false, optional).REQUIRED SCOPES:
forms.files
forms.documents