Documents

List the history of a document

GET/documents/{document_id}/history
documents:readlist_document_historyRead-only

Lists the events recorded for a document, newest first, one page at a time. Only signature events and changes to the document's own download and watermark settings are recorded. Users with the permission to manage user documents see every event; any other reader of the document sees only the events about themselves. A document the token cannot read returns 404. It changes nothing.

Path parameters

  • document_idstring (uuid)Required#

    The document's id.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • sortstring#

    Comma-separated fields to sort by: created_at. Prefix a field with - for descending. Defaults to -created_at. The id is always the final tiebreak.

  • filter[type]string#

    Only signature events or only settings events. Takes [in] and [not_in] with a comma-separated list.

    One of: signature, settings
  • filter[created_at]string#

    Only events in a range, written filter[created_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

Responses

200

The events.

DocumentHistoryEvent[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "type": "signature",
      "status": "string",
      "actioned_by": {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "name": "string"
      },
      "actioned_on": {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "name": "string"
      },
      "reason": "string",
      "error": "string",
      "signature_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/documents/{document_id}/history\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"