Returns flat list of all documents that are stored in OKdokument for given API key.
Service specification:
| URL | https://apidev.okdokument.com/JSON/list/flat |
| Query parameters state | Code of the state of documents to list * lists all states |
| Method | GET |
| Authentication | set header x-api-key |
| Response | HTTP 200 when successful |
The response body is a JSON array of objects where each object represents a document.
Properties of the array elements:
| filename | Name of the item. (*.pdf) |
| id | Unique identification of the document (used to send acknowledgments) |
| url | Link to download PDF document |
| state | State of the document: “tosign” or “signed” (set by an upload or acknowledgment operation) |
Example of a list of documents:
[
{
"filename": "462416f3-22ce-427b-8be9-b04e3b8665c7.pdf",
"state": "tosign",
"modification": "2022-06-01 14:11:40",
"id": "y7Ki_u1mrUwijfb-o_S1JiphSsoXya8iypH380F",
"url": "https://apidev.okdokument.com/rest/document/y7Ki_u1mrUwijfb-o_S1JiphSsoXya8iypH380F",
"date": 1655085500971,
"number": "1655085500880",
"group": "api_user"
},
...
]