Comment on page
List documents
get
https://api.zapsign.com.br
/api/v1/docs/?page=1
List documents
This endpoint allows you to list all documents in your account.
Parameters
Query
page
number
Page ranges from 1 to N (any positive integer). By default, this endpoint returns the list of documents in your account sorted into pages of 25 documents each. So, to go to the next page, change the "page=N" in the request.
Header
Authorization*
string
apiToken ahead of the "Bearer" text.
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Responses
200
Documents listed
If you only want to filter documents from a certain folder, add the optional parameter "folder_path" to the GET. For example:
All documents in the account (no folder filter):
https://api.zapsign.com.br/api/v1/docs/?api_token=abc&page=1
Filtering only documents without a folder (i.e. at the root "/"):
https://api.zapsign.com.br/api/v1/docs/?api_token=abc&page=1&folder_path=/
Filtering only documents in the "/api/folder2/" folder:
https://api.zapsign.com.br/api/v1/docs/?api_token=abc&page=1&folder_path=/api/pasta2/
If you wish to filter only deleted or non-deleted documents, add the optional "deleted" parameter to the GET request. For example:
Only non-deleted documents:
https://api.zapsign.com.br/api/v1/docs/?page=1&deleted=false
Only deleted documents:
https://api.zapsign.com.br/api/v1/docs/?page=1&deleted=true
Tip: instead of consulting documents several times a day, use our webhooks. In addition to saving the computing power of our servers and our servers, you will also be able to give feedback in real time to your user, not every N minutes.
Caution: the original_file and signed_file links are temporary and expires in 60 minutes. In case your system needs to save those links it is recommended that you save them in your own CDN or that you call this endpoint every time your user needs a valid URL that will expires in more 60 minutes.
{
"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 modified 2mo ago