v1
latestOpenAPI 3.0.22026-07-146168117.0 KBThis endpoint returns a list of documents. Please note that this feature is exclusively available as part of the Papersign API.
Query parameters
Search documents by name.
Filter to documents created from the given Paperform submission ID (matches source.paperform_submission_id). Use this to correlate a Paperform submission with its Papersign document without relying on the document.sent webhook.
Search folders that are descendants of folder id.
Search documents by status.
The number or results to return.
Number of results to skip in the result set.
Return results after the provided ID.
Return results before the provided ID.
Return results created on or after this date-time (UTC). Overwritten by before_id.
Return results created before this date (UTC). Overwritten by after_id.
The direction to sort in. Results are sorted by created_at, and defaults to "DESC".
Response
Successfully returned a list of documents
Example response
{
"results": {
"documents": [
{
"id": "5d40fdaf174b4c0007043072",
"name": "My Document",
"status": "completed",
"folder": {
"id": 9999,
"name": "My Document",
"parent_id": 9999,
"space_id": 8888
},
"space": {
"id": 9999,
"name": "My Space",
"root_folder_id": 9999,
"allow_team_access": true
},
"signers": [
{
"key": "akdj17",
"name": "Jack Smith",
"email": "signer@example.com",
"phone": "123 456 7899",
"job_title": "Account Manager",
"company": "Explosive Startup",
"custom_attributes": [
{
"key": "Relationship",
"label": "Relationship to the company",
"value": "CEO"
}
]
}
],
"variables": [
{
"key": "adk123",
"name": "Variable 1",
"value": "value 1"
}
],
"created_at_utc": "2019-04-14T09:00:00.000Z",
"updated_at_utc": "2019-04-14T09:00:00.000Z",
"sent_at_utc": "2019-04-14T09:00:00.000Z",
"completed_at_utc": "2019-04-14T09:00:00.000Z",
"source": {
"type": "paperform_submission",
"paperform_form_id": "iwl6j5lh",
"paperform_submission_id": "6a18dfcdcc9dc182fc0031cc"
}
}
]
},
"total": 57,
"has_more": true,
"limit": 20
}