Envelopes
Retrieve an envelope
Retrieve an envelope by its ID to read its status, documents, recipients and ceremony URLs, captured values and the deliverable link.
Retrieves the full details of an envelope, including its documents, recipients, deliverable, sender information, and captures.
Use this endpoint to check the current status of an envelope, retrieve recipient ceremony URLs, or access the deliverable download URL after completion.
All properties are returned regardless of the envelope’s current status. Properties not yet available (such as completed_at for an in-progress envelope) are returned as null.
Path parameters
The unique identifier of the envelope, in UUID format.
Returns
Returns a 200 OK status code along with an envelope object on success, or an error otherwise.
GET /v1/envelopes/eb4cf433-a8af-4161-b37b-7ef57d423e56 HTTP/1.1
Host: api.signatureapi.com
X-API-Key: YOUR_API_KEYnpx signatureapi envelopes get eb4cf433-a8af-4161-b37b-7ef57d423e56{
"name": "get_envelope",
"arguments": {
"envelope_id": "eb4cf433-a8af-4161-b37b-7ef57d423e56"
}
}{
"id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
"title": "Service Agreement",
"label": "Service Agreement for Acme Corp onboarding",
"message": "Please review the agreement and provide your signature.",
"status": "completed",
"mode": "test",
"routing": "parallel",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"attestation": "none",
"branding": {
"logo": null,
"accent_color": "#2463eb",
"email": {
"from": "noreply@signatureapi.com",
"footer": null,
"logo_position": "left"
}
},
"sender": {
"name": "Acme Corp Legal",
"email": "legal@acme.example",
"organization": "Acme Corp"
},
"topics": [
"sales"
],
"metadata": {
"customer_ref": "acme-1042"
},
"documents": [
{
"id": "doc_4YvlxUZN28CeonDq6rTbvk",
"envelope_id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
"key": "service_agreement",
"title": "Service Agreement",
"page_count": 1,
"url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/acme-service-agreement.pdf",
"format": "pdf",
"fixed_positions": [],
"places": [
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client",
"height": 60
},
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "provider",
"height": 60
}
]
}
],
"recipients": [
{
"id": "re_49r1R2jpPDz8hSpP75ZkPp",
"envelope_id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
"type": "signer",
"key": "client",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"status": "completed",
"ceremony": {
"authentication": [
{
"type": "email_link",
"subject_override": null,
"message_override": null
}
],
"redirect_url": null,
"redirect_delay": 3,
"embeddable_in": [],
"url_variant": "standard",
"url": null
},
"delivery_type": "email",
"ceremony_creation": "automatic",
"signature_options": [
"typed",
"drawn"
],
"completed_at": "2026-11-02T14:41:02.000Z",
"status_updated_at": "2026-11-02T14:41:02.000Z"
},
{
"id": "re_4VP9v4uPj6jwZzQ14CG2O8",
"envelope_id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
"type": "signer",
"key": "provider",
"name": "John Smith",
"email": "john.smith@example.com",
"status": "completed",
"ceremony": {
"authentication": [
{
"type": "email_link",
"subject_override": null,
"message_override": null
}
],
"redirect_url": null,
"redirect_delay": 3,
"embeddable_in": [],
"url_variant": "standard",
"url": null
},
"delivery_type": "email",
"ceremony_creation": "automatic",
"signature_options": [
"typed",
"drawn"
],
"completed_at": "2026-11-02T15:21:40.000Z",
"status_updated_at": "2026-11-02T15:21:40.000Z"
}
],
"deliverable": {
"id": "del_6FF89lKNyTNamOJCJd1tLL",
"name": null,
"envelope_id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
"type": "standard",
"status": "generated",
"url": "https://vault.signatureapi.com/envelopes/eb4cf433-a8af-4161-b37b-7ef57d423e56/deliverables/del_6FF89lKNyTNamOJCJd1tLL/sealed.pdf?Expires=1794240000&Signature=EXAMPLE_SIGNATURE&Key-Pair-Id=EXAMPLE_KEY_ID",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"included_documents": [
"service_agreement"
],
"password": null,
"created_at": "2026-11-02T14:03:11.000Z",
"generated_at": "2026-11-02T15:21:45.000Z"
},
"captures": {},
"snapshot_url": null,
"created_at": "2026-11-02T14:03:11.000Z",
"completed_at": "2026-11-02T15:21:40.000Z"
}{
"type": "https://signatureapi.com/docs/v1/errors/not-found",
"title": "Not Found",
"status": 404,
"detail": "The envelope was not found."
}Errors every call can return are in Errors and Authentication.