Skip to content

List Documents

GET {{base_url}}/v1/documents

Returns a paginated list of all documents (envelopes) created by the organization. By default, each item includes the attachment count; if you need to retrieve the full detail of attachments, you can expand the relationship in the query.


ParameterTypeDescriptionLimits
Authorization*stringBearer authentication token.Required (Bearer <token>)

ParameterTypeDescriptionLimits
include[]string[]Allows expanding object relationships. Use children to populate the full attachments array (extra_docs). Ex: ?include[]=childrenOptional

Returns a collection of Document objects. In this example, the first element shows the structure when expansion is not requested (attachment values are null) and the second shows an element with the expanded relationship.

[
{
"external_id": "ERP-123",
"token": "abcdef01-...",
"name": "CONTRATO DE PRESTACIÓN DE SERVICIOS N°9.pdf",
"folder": { "token": "uuid", "name": "Carpeta" },
"status": "pending",
"lang": "es",
"size": 245100,
"original_file": "[{{base_url}}/v1/files/...?intent=view&signature=]({{base_url}}/v1/files/...?intent=view&signature=)...",
"signed_file": null,
"original_download_file": "[{{base_url}}/v1/files/...?intent=download]({{base_url}}/v1/files/...?intent=download)&...",
"signed_download_file": null,
"signatures_made": 0,
"signature_deadline": "2026-12-31T23:59:59.000Z",
"created_by": { "email": "[email protected]" },
"extra_docs": null,
"extra_docs_count": 2,
"signers": [
{
"external_id": null,
"token": "signer-api-id",
"status": "pending",
"name": "Jane Doe",
"email": "[email protected]",
"role": "signer",
"link": "[https://app.firmeasy.legal/](https://app.firmeasy.legal/)...",
"placements": [
{
"document_ref": "main",
"type": "signature",
"page_number": 1,
"relative_position_left": 36.5,
"relative_position_top": 39.25,
"relative_size_width": 25,
"relative_size_height": 8
}
]
}
],
"created_through": "api",
"metadata": { "order_id": "12345" },
"created_at": "2026-06-23T10:00:00.000000Z",
"updated_at": "2026-06-23T10:00:00.000000Z"
},
{
"external_id": "ERP-124",
"token": "789fgh02-...",
"name": "ADENDA DE CONTRATO DE LOCACIÓN.pdf",
"folder": null,
"status": "signed",
"lang": "es",
"size": 124000,
"original_file": "[{{base_url}}/v1/files/...?intent=view&signature=]({{base_url}}/v1/files/...?intent=view&signature=)...",
"signed_file": "[{{base_url}}/v1/files/...?intent=view&signature=]({{base_url}}/v1/files/...?intent=view&signature=)...",
"original_download_file": "[{{base_url}}/v1/files/...?intent=download]({{base_url}}/v1/files/...?intent=download)&...",
"signed_download_file": "[{{base_url}}/v1/files/...?intent=download]({{base_url}}/v1/files/...?intent=download)&...",
"signatures_made": 1,
"signature_deadline": "2026-08-15T18:00:00.000Z",
"created_by": { "email": "[email protected]" },
"extra_docs": [
{
"token": "anexo-token-99",
"name": "Anexo de Especificaciones Técnicas.pdf",
"original_file": "[{{base_url}}/v1/files/.../?intent=view]({{base_url}}/v1/files/.../?intent=view)&...",
"signed_file": null,
"original_download_file": "[{{base_url}}/v1/files/.../?intent=download]({{base_url}}/v1/files/.../?intent=download)&...",
"signed_download_file": null,
"uploaded_by": { "email": "[email protected]" }
}
],
"extra_docs_count": 1,
"signers": [
{
"external_id": null,
"token": "signer-api-2",
"status": "signed",
"name": "James Smith",
"email": "[email protected]",
"role": "signer",
"link": "[https://app.firmeasy.legal/](https://app.firmeasy.legal/)...",
"placements": [
{
"document_ref": "main",
"type": "signature",
"page_number": 2,
"relative_position_left": 10.0,
"relative_position_top": 45.0,
"relative_size_width": 20,
"relative_size_height": 10
}
]
}
],
"created_through": "api",
"metadata": {},
"created_at": "2026-06-24T08:30:00.000000Z",
"updated_at": "2026-06-24T09:15:00.000000Z"
}
]
NombreTypeDescription
external_idstringYour external ID (pass-through).
tokenstring (UUID)Document identifier (use it in other endpoints).
namestringEnvelope name (normalized to UPPERCASE + .pdf).
folderobjectDestination folder containing token and name.
statusstringDocument status: pending · signed · rejected.
langstringInterface language: es · en · pt.
sizeintegerFile size in bytes.
original_filestring (URL)Temporary viewing URL for the original file (expires in 60 min).
signed_filestring (URL)Temporary viewing URL for the signed file (null until >=1 signature, expires in 60 min).
original_download_filestring (URL)Temporary download URL for the original file with filename (expires in 60 min).
signed_download_filestring (URL)Temporary download URL for the signed file (expires in 60 min).
signatures_madeintegerNumber of signatures applied.
signature_deadlinestring (ISO8601)Signature deadline date in Y-m-d\TH:i:s.v\Z format.
created_byobjectDocument creator containing the email.
extra_docsarrayArray of attachments (only if the envelope has them). Always present in create and webhooks or expanded via include.
extra_docs_countintegerNumber of attachments. Always present in the listing; cheap signal without fetching the array.
signersarrayCollection of envelope signers with their respective flows and placements.
trackingarrayDocument audit and tracking events.
created_throughstringCreation channel: api · web.
reminder_every_n_daysintegerAutomatic reminder frequency (0-30 days).
send_automatic_invitationsbooleanIndicates whether automatic invitations are sent upon creation.
send_signed_document_by_whatsappbooleanIndicates whether the signed document is sent via WhatsApp.
is_rejection_allowedbooleanAllow document rejection by signers.
is_signature_order_activebooleanIndicates whether the configured signature order is strictly enforced.
redirect_linkstringPost-signature redirect URL.
observersarrayObserver emails (read-only).
metadataobjectPass-through of free-form data in key-value format.
created_atstring (ISO8601)Record creation date.
updated_atstring (ISO8601)Last record update date.

Code Status Description
401 Unauthorized The authentication token is invalid, expired, or was not sent.
422 Unprocessable Entity The sorting parameters, filters, or relationships requested in include are not valid.