Get List of all Documents

In order to get the list of all documents, send a GET request to the /documents resource. The response contains a paginated list of all documents.

//get a list of all documents

    GET /documents

Request query parameters

Name	Type	Description
`limit`	`number`	Optional: Maximum number of documents to return (default 20).
`offset`	`number`	Optional: Starting offset (default 0).

//example request

curl -H 'Authorization: BEARER <token>'
    -H 'Accept: application/vnd.gini.v1+json'
    -X GET -i https://pay-api.gini.net/documents?limit=50

Response

The response contains a paginated list of documents.

Headers

Status Code	Description
200 (OK)	Operation is successful.

Body

The response entity has the following fields:

Name	Type	Description
`documents`	`array`	All documents of the current result page.

//example response

{
  "documents": [
    {...},
    {...},
    ...
  ]
}