Documents
Get a document
get/documents/{id}
Returns the document and each recipient's progress. fields appears only once the document is complete.
Needs a key with documents:read.
Path parameters
idUUIDRequiredThe document ID.
Example request
curl "https://www.inkly.so/api/v1/documents/3f1c2a7e-8b4d-4e21-9a6f-5d0c7e1b2a34" \
-H "Authorization: Bearer $INKLY_API_KEY"Example response, 200
{
"document": {
"id": "3f1c2a7e-8b4d-4e21-9a6f-5d0c7e1b2a34",
"title": "Consulting agreement",
"status": "sent",
"external_id": "crm-8841",
"template_id": "a2d94c10-6e7b-4f38-8c15-1f3e9b7d6c02",
"source": "api",
"signing_link_id": null,
"created_at": "2026-11-02T15:04:05.123Z",
"sent_at": "2026-11-02T15:04:05.123Z",
"completed_at": null,
"voided_at": null,
"archived_at": null,
"recipients": [
{
"id": "5b7e9d13-2c84-4f06-b1a9-6d40e8c2f715",
"ref": null,
"role": "signer",
"name": "Alex Morgan",
"email": "alex@example.com",
"delivery": "email",
"status": "viewed",
"signing_step": null,
"is_signing_turn": true,
"viewed_at": "2026-11-02T15:04:05.123Z",
"signed_at": null,
"declined_at": null,
"decline_reason": null,
"invite_delivery": "sent",
"attachments": []
}
]
}
}Response fields
documentobjectRequired14 child fields
idUUIDRequiredtitlestringRequiredstatusstringRequiredOne of
draft,sent,completed,declined,voidedexternal_idstring or nullRequiredtemplate_idUUID or nullRequiredsourcestringRequiredOne of
api,app,bulk,linksigning_link_idUUID or nullRequiredcreated_attimestampRequiredsent_attimestamp or nullRequiredcompleted_attimestamp or nullRequiredvoided_attimestamp or nullRequiredarchived_attimestamp or nullRequiredrecipientsarray of objectsRequired15 child fields
idUUIDRequiredrefstring or nullRequiredrolestringRequiredOne of
signer,ccnamestring or nullRequiredemailstring or nullRequireddeliverystringRequiredOne of
email,linkstatusstringRequiredOne of
pending,viewed,signed,declinedsigning_stepnumber or nullRequiredis_signing_turnbooleanRequiredviewed_attimestamp or nullRequiredsigned_attimestamp or nullRequireddeclined_attimestamp or nullRequireddecline_reasonstring or nullRequiredinvite_deliverystring or nullRequiredOne of
pending,sending,sent,failed,bounced,complained,suppressedattachmentsarray of objectsRequired6 child fields
idUUIDRequiredfile_namestringRequiredcontent_typestringRequiredOne of
application/pdf,image/jpeg,image/pngsizenumberRequireduploaded_attimestampRequiredrequest_labelstring or nullRequired
fieldsarray of objects6 child fields
idUUIDRequiredrecipient_idUUIDRequiredtypestringRequiredOne of
signature,initials,name,email,date,text,number,checkbox,dropdownlabelstringRequiredvalueany or nullRequiredfilledboolean
Errors specific to this endpoint
document_not_found404Document not found.
Every endpoint can also return the common errors.