Listar documentos archivados
Este endpoint lista los documentos que creaste en una carpeta de trabajo y que están archivados. Son los que ya no aparecen en Listar documentos por estado.
Método: GET https://api.digitafirma.com/v1/documents/archived
Query Parameters
Sección titulada «Query Parameters»| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
company_id | string | Sí | ID de la carpeta de trabajo (consulta Listar carpetas de trabajo). |
searchName | string | Sí | Texto que debe contener el nombre del archivo. Envíalo vacío (searchName=) para no filtrar por nombre. |
page | integer | No | Página a consultar. Empieza en 0. |
size | integer | No | Documentos por página. Por defecto 20. |
sort | string | No | Orden de los resultados, por ejemplo createdAt,desc. |
Igual que en el listado principal, solo aparecen los documentos que creó el usuario de la X-Api-Key, y la paginación funciona igual que en Listar documentos por estado.
Ejemplo de integración
Sección titulada «Ejemplo de integración»curl --location 'https://api.digitafirma.com/v1/documents/archived?company_id={company_id}&searchName=&sort=createdAt,desc' \--header 'X-Api-Key: {X-API-KEY}'Cada documento tiene la misma estructura que en Mostrar un documento. Aquí se muestran solo algunos atributos.
{ "data": [ { "type": "documents", "id": "ac110005-9df4-1d1b-819d-f60440bc003c", "links": { "self": "/documents/ac110005-9df4-1d1b-819d-f60440bc003c" }, "attributes": { "file_name": "contrato-servicios.pdf", "sign_status": 3, "signed": true, "owner": "Juan Pérez <juan.perez@ejemplo.com>", "isOwner": true, "signed_at": "2026-05-06T10:15:32.481920", "created_at": "2026-05-04T20:42:47.172839" } } ], "meta": [ { "page": { "total": 1, "initialItem": 0, "totalItems": 1 } } ], "links": { "self": "/documents" }}{ "errors": [ { "status": 400, "title": "Domain Error", "detail": "La compañia no pudo ser encontrada" } ]}Errores comunes
Sección titulada «Errores comunes»| Código | Mensaje | Causa |
|---|---|---|
| 400 | La compañia no pudo ser encontrada | El company_id no existe. |
| 400 | — | Falta company_id o searchName en la petición. |
| 401 | — | Falta la X-Api-Key o no es válida. |