Listar documentos
This endpoint is cached by default with a TTL of 60 seconds.
Listar documentos
GET
https://api.zapsign.com.br/api/v1/docs/?page=1
Este endpoint te permite listar todos los documentos de la cuenta de ZapSign.
Query Parameters
page
number
Las páginas van del 1 al N (cualquier número positivo). De manera predeterminada, este endpoint devuelve la lista de documentos de tu cuenta ordenada en páginas de 25 documentos cada una. Así que, para acceder a la siguiente página, solo necesitas cambiar el parámetro "page=N" en la solicitud.
Encabezado
Authorization*
string
API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
[
{
"open_id": 1,
"token": "7d23fcfa-d37e-44c6-a3c1-677a66383910",
"status": "pending",
"name": "Document test",
"original_file": "https://zapsign.s3.amazonaws.com/pdf/0431xxx8-2145-463f-ab2d-540eb77aa3fd/fe998382-cae7-4dd7-8028-cbc679d800d3.pdf",
"signed_file": null,
"created_at": "2020-04-16T02:43:31.500058Z",
"last_update_at": "2020-04-16T02:43:31.500122Z"
},
{
"open_id": 2,
"token": "6b9da26c-b5d1-497e-9516-6a82fbadaa20",
"status": "pending",
"name": "Document test 2",
"original_file": "https://zapsign.s3.amazonaws.com/pdf/3ebxxxc67-df04-412f-99e9-d1338377f7e2/9e16a4cb-7176-4a2f-8cf9-eb9289f7a8e7.pdf",
"signed_file": null,
"created_at": "2020-04-16T02:44:13.713004Z",
"last_update_at": "2020-04-16T02:44:13.713060Z"
},
{
"open_id": 3,
"token": "12f7e1e0-71d0-4581-a49c-9f9ce6e3cae1",
"status": "signed",
"name": "Document test 3",
"original_file": "https://zapsign.s3.amazonaws.com/pdf/5xxx1fa0-eaa6-4d5e-ab6a-46cb942f07ef/1aaacad4-ef56-40a6-bd23-3eb9e309a6cf.pdf",
"signed_file": "https://zapsign.s3.amazonaws.com/pdf/8xxxccca0-eaa6-4d5e-ab6a-46cb942f07ef/1aaacad4-ef56-40a6-bd23-3eb9e309a6cf.pdf",
"created_at": "2020-04-16T02:51:01.918228Z",
"last_update_at": "2020-04-16T02:51:01.918333Z"
}
]
Filtrar y ordenar los documentos
If you only want to filter documents from a certain folder, add the optional parameter "folder_path" to the GET. For example:
Carpetas
folder_path
Todos los documentos sin carpeta ("/"): https://api.zapsign.com.br/api/v1/docs/?api_token=abc&page=1&folder_path=/
Documentos en una carpeta específica: https://api.zapsign.com.br/api/v1/docs/?api_token=abc&page=1&folder_path=/api/nombreCarpeta/
Documentos eliminados
deleted
https://api.zapsign.com.br/api/v1/docs/?page=1&deleted=true
Estado del documento
status
Firmados: https://api.zapsign.com.br/api/v1/docs/?page=1&status=signed
Pendientes: https://api.zapsign.com.br/api/v1/docs/?page=1&status=pending
Rechazados: https://api.zapsign.com.br/api/v1/docs/?page=1&status=refused
Fecha de creación
created_from created_to
En un rango de fechas: https://api.zapsign.com.br/api/v1/docs/?page=1&created_from=2024-01-01&created_to=2024-01-30
Ordenar la lista de documentos por fecha de creación
Si deseas ordenar la respuesta de la lista de documentos según la fecha de creación, puedes agregar el parámetro opcional 'sort_order' a la solicitud GET. A continuación te mostramos cómo hacerlo:
Para ordenar los documentos de manera ascendente (más antiguos primero):
https://api.zapsign.com.br/api/v1/docs/?page=1&sort_order=asc
Para ordenar los documentos de manera descendente (más recientes primero):
https://api.zapsign.com.br/api/v1/docs/?page=1&sort_order=desc
Request
Response
Advertencia: los enlaces original_file y signed_file son temporales y caducan en 60 minutos. Si tu sistema necesita guardar esos enlaces, se recomienda almacenarlos en tu propio CDN o llamar al endpoint de Detalle del documento cada vez que tu usuario necesite una URL válida que caduque en más de 60 minutos.
{
"count": 336,
"next": "https://api.zapsign.com.br/api/v1/docs/?api_token=xxxx&page=4",
"previous": "https://api.zapsign.com.br/api/v1/docs/?api_token=xxxx&page=2",
"results": [
{
"open_id": 201,
"token": "373xxxx-5f7e-4218-917e-9b6f6f7b2aa1",
"status": "signed",
"name": "Contrato X.pdf",
"original_file": "https://zapsign.s3.amazonaws.com/docs/f8d1e963-f4ce-471b-xxxxxfd6e43f6/60eexxxxxc1-9410-81a769ea53b5.pdf",
"signed_file": "https://zapsign.s3.amazonaws.com/pdf/582a15yyyyy42-f105291252e1.pdf",
"created_at": "2020-04-02T13:52:21.948145Z",
"last_update_at": "2020-04-02T16:10:30.780585Z",
"created_through": "api"
},
...
]
}
Last updated
Was this helpful?