Documents
Get a document
- Envelopes
- Recipients
- Documents
- Deliverables
- Events
- Files
Resources
Documents
Get a document
Retrieves the details of an existing document.
GET
/
v1
/
documents
/
{document_id}
// GET https://api.signatureapi.com/v1/documents/{document_id}
// X-API-Key: key_test_...
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
"format": "docx",
"data": {
"date": "December 31st, 2025",
"show_alert": true,
"service_provider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
}
}
Path Parameters
document_id
string
requiredThe unique identifier of a document.
Returns
Returns a 200 OK
status code along with a document object if successful, or an error otherwise.
// GET https://api.signatureapi.com/v1/documents/{document_id}
// X-API-Key: key_test_...
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
"format": "docx",
"data": {
"date": "December 31st, 2025",
"show_alert": true,
"service_provider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
}
}
Was this page helpful?
// GET https://api.signatureapi.com/v1/documents/{document_id}
// X-API-Key: key_test_...
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
"format": "docx",
"data": {
"date": "December 31st, 2025",
"show_alert": true,
"service_provider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
}
}