| Page Properties | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
In order to get the list of all documents, send a GET request to the /documents resource. The response will contain contains a paginated list of all documents.
...
| Code Block | ||
|---|---|---|
| ||
//get a list of all documents
GET /documents |
Request query parameters
Name | Type | Description |
|---|---|---|
|
|
Optional |
: Maximum number of documents to return (default 20). |
offset
|
|
Optional: the next creation date(in number form) of the next paginated documents(default 0). |
| Code Block | ||
|---|---|---|
| ||
//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 will contain 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 |
|---|---|---|
|
| All documents of the current result page. |
| Code Block | ||
|---|---|---|
| ||
//example response { "documents": [ {...}, {...}, ... ] } |