List all documents
Returns a list of your documents. The documents are returned sorted by creation date, with the most recently created documents appearing first.
Parameters
state
enum
The state of documents to return. The default is active. One of
all, active, archived, trashed.Returns
Return a paginated response that contains an array of up to the specified limit of documents.
get
/api/documents
curl https://{workspace}.documocu.com/api/documents \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {API_KEY}'
Response
{
"data": [
{
"activity": [],
"allow_download": false,
"allow_forwarding": true,
"archived_at": null,
"author": {
"email": "[email protected]",
"id": "f2f3f9f8-8a0e-3c0f-b3d0-afd6e159ac9a",
"name": "Ned Ullrich Sr."
},
"completed_at": null,
"cover_page": null,
"created_at": "2024-05-14T07:25:59+00:00",
"currency": "USD",
"declined_at": null,
"deleted_at": null,
"expiration_date": null,
"expiration_date_in_days": null,
"expiration_warning": false,
"expired_at": null,
"id": "1c594aa5-f1c2-3700-84d0-f5ada7406856",
"modifier": {
"email": "[email protected]",
"id": "bf2d0296-ad33-3001-9540-e378356014db",
"name": "Prof. Jamal Hirthe"
},
"name": "In nostrum libero et voluptatum a autem facilis.",
"page_orientation": "portrait",
"page_size": "a4",
"recipient_language": "en_US",
"recipients": [],
"recurring_reminder_frequency": null,
"recurring_reminder_period_unit": null,
"reminder_days": null,
"sent_at": null,
"sent_via": null,
"status": "draft",
"type": "regular",
"updated_at": "2024-05-14T07:25:59+00:00",
"value": 0,
"viewed_at": null
}
],
"links": {
"first": "https://{workspace}.documocu.com/api/documents?page=1",
"last": "https://{workspace}.documocu.com/api/documents?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://{workspace}.documocu.com/api/documents?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://{workspace}.documocu.com/api/documents",
"per_page": 20,
"to": 2,
"total": 2
}
}