"
},
{
"info": {
"name": "Get File",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://forms.skyslope.com/partner/api/files/:fileId",
"params": [
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to retrieve."
}
]
},
"docs": "Retrieve the details of a listing or transaction file.
forms.files
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Update File Details",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://forms.skyslope.com/partner/api/files/:fileId",
"params": [
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the file details of a listing or transaction file.
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Add Contact to File",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://forms.skyslope.com/partner/api/files/:fileId/contacts",
"params": [
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to add the contact to."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a contact to a file.
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Update Contact in File.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://forms.skyslope.com/partner/api/files/contacts/:contactId",
"params": [
{
"name": "contactId",
"value": "",
"type": "path",
"description": "The id of the contact to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a contact in a file.
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Add Contacts to File",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://forms.skyslope.com/partner/api/files/:fileId/contacts/bulk",
"params": [
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to add the contacts to."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add one or more contacts to a file.
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Delete Contact from File.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://forms.skyslope.com/partner/api/files/:fileId/contacts/:contactId",
"params": [
{
"name": "contactId",
"value": "",
"type": "path",
"description": "The id of the contact to delete."
},
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to delete the contact from."
}
]
},
"docs": "Delete a contact from a file.
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Get File Documents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://forms.skyslope.com/partner/api/files/:fileId/documents",
"params": [
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to retrieve documents for."
}
]
},
"docs": "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:
REQUIRED SCOPES:
forms.files
REQUIRED SCOPES:
forms.documents
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Get Envelopes in File",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://forms.skyslope.com/partner/api/files/:fileId/envelopes",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "The page number to retrieve."
},
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "The number of files returned per page."
},
{
"name": "filters",
"value": "",
"type": "query",
"description": "A sieve filter to that will be applied to the results."
},
{
"name": "sorts",
"value": "",
"type": "query",
"description": "A sieve list of sort fields to sort the results by."
},
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to retrieve envelopes for."
}
]
},
"docs": "Get the envelopes associated with a file.
REQUIRED SCOPES:
forms.files
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Apply Template to File",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://forms.skyslope.com/partner/api/files/:fileId/templates",
"params": [
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to apply the template to."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Apply a template to a file.
REQUIRED SCOPES:
"
},
{
"info": {
"name": "Download File Documents as PDF",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://forms.skyslope.com/partner/api/files/:fileId/documents/download/pdf",
"params": [
{
"name": "documentIds",
"value": "",
"type": "query",
"description": "Comma-separated list of document IDs to include in the PDF. Example: \"123,456,789\""
},
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The id of the file to download documents from."
}
]
},
"docs": "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: