Documents

List documents

get/documents

Lists documents in the workspace, newest first, including those sent from the app.

Needs a key with documents:read.

Query parameters

limitnumber
How many results to return per page.
1 to 100 · Default 25
cursorstring
The next_cursor value from the previous page. Treat it as opaque.
statusstring
Only documents with this status.
One of draft, sent, completed, declined, voided
template_idUUID
Only documents sent from this template.
external_idstring
Only documents with this external_id.
Up to 255 characters
signing_link_idUUID
Only documents started from this public signing link.

Example request

curl "https://www.inkly.so/api/v1/documents?limit=25&status=completed" \
  -H "Authorization: Bearer $INKLY_API_KEY"

Example response, 200

{
  "documents": [
    {
      "id": "3f1c2a7e-8b4d-4e21-9a6f-5d0c7e1b2a34",
      "title": "Consulting agreement",
      "status": "sent",
      "external_id": "crm-8841",
      "template_id": "a2d94c10-6e7b-4f38-8c15-1f3e9b7d6c02",
      "source": "api",
      "signing_link_id": null,
      "created_at": "2026-11-02T15:04:05.123Z",
      "sent_at": "2026-11-02T15:04:05.123Z",
      "completed_at": null,
      "voided_at": null,
      "archived_at": null
    }
  ],
  "next_cursor": null
}

Response fields

documentsarray of objectsRequired
12 child fields
- idUUIDRequired
- titlestringRequired
- statusstringRequired
  One of draft, sent, completed, declined, voided
- external_idstring or nullRequired
- template_idUUID or nullRequired
- sourcestringRequired
  One of api, app, bulk, link
- signing_link_idUUID or nullRequired
- created_attimestampRequired
- sent_attimestamp or nullRequired
- completed_attimestamp or nullRequired
- voided_attimestamp or nullRequired
- archived_attimestamp or nullRequired
next_cursorstring or nullRequired

Errors specific to this endpoint

invalid_request400The request is invalid.
unknown_field400This field is not supported.

Every endpoint can also return the common errors.