English

List documents

This endpoint is cached by default with a TTL of 60 seconds.

List documents

GET https://api.zapsign.com.br/api/v1/docs/?page=1

This endpoint allows you to list all documents in your account.

Query Parameters

NameTypeDescription

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.

Headers

NameTypeDescription

Authorization*

string

apiToken ahead of the "Bearer" text.

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"
    }
]

Filtering documents by folder

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/

Filtering deleted or non-deleted documents

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

Filtering documents by status

If you wish to filter only signed, pending or refused documents, add the optional "status" parameter to the GET request. For example:

Only signed documents: https://api.zapsign.com.br/api/v1/docs/?page=1&status=signed

Only pending documents: https://api.zapsign.com.br/api/v1/docs/?page=1&status=pending

Only refused documents: https://api.zapsign.com.br/api/v1/docs/?page=1&status=refused

Filtering documents by creation date

If you wish to filter documents by creation date, add the optional parameters 'created_from' and 'created_to' to the GET request, with the format YYYY-MM-DD. For example:

Only documents created on January, 2024: https://api.zapsign.com.br/api/v1/docs/?page=1&created_from=2024-01-01&created_to=2024-01-30

Ordering the response of the request

If you wish to sort the response of the document listing by creation date, add the optional parameter 'sort_order' to the GET request. For example:

Sorting documents in ascending order: https://api.zapsign.com.br/api/v1/docs/?page=1&sort_order=asc

Sorting documents in descending order: https://api.zapsign.com.br/api/v1/docs/?page=1&sort_order=desc

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.

Request

Response

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"
        },
        ...
    ]
}
PreviousDetail documentNextDelete document

Last updated