Signatures

List the documents of a contract template

GET/contract-templates/{contract_template_id}/documents
signatures:readlist_contract_template_documentsRead-only

Lists the documents of one contract template in the order they were added. Each shows the document and its name; signature_id and signature_status are null for a template. 404 for an unknown template or one the caller cannot see. As in the platform, every document of a template the caller can see is listed; read a document with GET /documents/{id}, which applies its own access. Deleted documents are left out. Changes nothing.

Path parameters

  • contract_template_idstring (uuid)Required#

    The contract template'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.

Responses

200

One page of records.

ContractDocument[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "document_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "document_name": "string",
      "signature_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "signature_status": "pending",
      "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/contract-templates/{contract_template_id}/documents\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"