Signatures

List contracts

GET/contracts
signatures:readlist_contractsRead-only

Lists contracts, newest first, one page at a time. A contract is visible when its folder is readable by the caller; others answer 404. Templates are not contracts: see GET /contract-templates. Investors and advisors see only contracts held by themselves or by one of their teams; others see every contract in a readable folder. filter[signatory_id] matches a contract held by that id and, for a user id, by that user's team. Reading never creates a contract from a template. POST /contracts/exports makes a CSV.

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[folder_id]string (uuid)#

    Rows kept directly in this folder, not in its subfolders. Takes [in] and [not_in] with a comma-separated list.

  • filter[within_folder_id]string (uuid)#

    Rows kept in a folder in this folder's subtree. Takes [in] and [not_in] with a comma-separated list of at most 50 folder ids.

  • filter[deal_id]string (uuid)#

    Contracts kept in the folder tree of this deal. A deal the caller cannot see gives an empty list. Takes [in] and [not_in] with a comma-separated list.

  • filter[signatory_id]string (uuid)#

    Contracts held by this id. For a user id, also the contracts held by that user's team. Takes [in] and [not_in] with a comma-separated list.

  • filter[signatory_type]string#

    Contracts held by a user or by a team: user or group. Takes [in] and [not_in] with a comma-separated list.

    One of: user, group
  • filter[template_id]string (uuid)#

    Contracts made from this template. Takes [in] and [not_in] with a comma-separated list.

  • filter[completed]boolean#

    true for contracts that are completed, false for open ones.

  • filter[created_at]string (date-time)#

    Created at or after / before a UTC date-time such as 2026-03-01T00:00:00Z. Use [gt], [gte], [lt] or [lte].

Responses

200

One page of records.

Contract[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "folder_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "signatory": {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "type": "user"
      },
      "template_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "completed_at": "2026-06-12T10:00:00+00:00",
      "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/contracts\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"