Esse endpoint possui um cache com expiração de 60 minutos.
Listar documentos
GEThttps://api.zapsign.com.br/api/v1/docs/?page=1
Esse endpoint permite que você liste todos os documentos da sua conta.
Query Parameters
Name
Type
Description
page
number
Page vai de 1 a N (qualquer número inteiro positivo). Por default, este endpoint retorna a lista de documentos na sua conta ordenada em páginas com 25 documentos cada. Assim, para ir para a próxima página, mude o "page=N" na requisição.
Headers
Name
Type
Description
Authorization*
string
Api token a frente do texto "Bearer".
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
[{"open_id":1,"token":"7d23fcfa-d37e-44c6-a3c1-677a66383910","status":"pending","name":"Documento teste","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":"Documento teste 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":"Documento teste 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"}]
Filtrando documentos de uma pasta
Caso você deseje filtrar apenas documentos de uma determinada pasta, acrescente ao GET o parâmetro opcional "folder_path". Por exemplo:
Todos documentos da conta (sem filtro de pasta):
https://api.zapsign.com.br/api/v1/docs/?page=1
Filtrando somente documentos Sem pasta (ou seja, na raiz "/"):
https://api.zapsign.com.br/api/v1/docs/?page=1&folder_path=/
Filtrando somente documentos na pasta "/api/pasta2/":
https://api.zapsign.com.br/api/v1/docs/?page=1&folder_path=/api/pasta2/
Filtrando documentos excluídos ou não excluídos
Caso você deseje filtrar apenas documentos excluídos ou não excluídos, acrescente ao GET o parâmetro opcional "deleted". Por exemplo:
Apenas documentos não excluídos:
https://api.zapsign.com.br/api/v1/docs/?page=1&deleted=false
Apenas documentos excluídos:
https://api.zapsign.com.br/api/v1/docs/?page=1&deleted=true
Filtrando por signatários
Caso você queira filtrar por signatário, acrescente ao GET o parâmetro opcional "signer_email". Por exemplo:
Por e-mail do signatário:
https://api.zapsign.com.br/api/v1/docs/?page=1&[email protected]
Filtrando documentos por status
Caso você deseje filtrar documentos assinados, em curso ou recusados, acrescente ao GET o parâmetro opcional "status". Por exemplo:
Apenas documentos assinados:
https://api.zapsign.com.br/api/v1/docs/?page=1&status=signed
Apenas documentos em curso:
https://api.zapsign.com.br/api/v1/docs/?page=1&status=pending
Apenas documentos recusados:
https://api.zapsign.com.br/api/v1/docs/?page=1&status=refused
Filtrando documentos por data de criação
Caso você deseje filtrar documentos por data de criação, acrescente ao GET os parâmetros opcionais "created_from" e "created_to", com o formato YYYY-MM-DD. Por exemplo:
Apenas documentos criados em janeiro de 2024:
https://api.zapsign.com.br/api/v1/docs/?page=1&created_from=2024-01-01&created_to=2024-01-30
Ordenando a resposta da requisição
Caso você deseje ordenar a resposta da listagem dos documentos por data de criação, acrescente ao GET o parâmetro opcional "sort_order". Por exemplo:
Ordenando documentos em ordem ascendente:
https://api.zapsign.com.br/api/v1/docs/?page=1&sort_order=asc
Ordenando documentos em ordem descendente:
https://api.zapsign.com.br/api/v1/docs/?page=1&sort_order=desc
Dica: em vez de consultar os documentos várias vezes ao dia, utilize nossos webhooks. Além de ser uma economia da capacidade computacional dos nossos e seus servidores, você também conseguirá dar um feedback em tempo real ao seu usuário, e não a cada N minutos.
Exemplo de resposta
Atenção: os links retornados em original_file e signed_file são temporários e duram 60 minutos. Caso seu sistema necessite salvar estes links é recomendado que sejam baixados em uma CDN própria ou que este endpoint seja consultado sempre para garantir que seu usuário sempre receberá um link válido.
