Signatures

List counter versions

GET/counter-versions
signatures:readlist_counter_versionsRead-only

Lists counters made on documents, newest first. Counters reply to one another through parent_id; the first of a chain has a null one (filter[parent_id][null]=true). A counter is visible when its original document is readable by the caller, and investors and advisors see only counters they made. Keyed on the original document (document_id); the old counter list filtered on the counter's own file, a defect not carried over. Changes nothing.

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

    Counters of this original document. Takes [in] and [not_in] with a comma-separated list.

  • filter[contract_id]string (uuid)#

    Counters made on this contract. Takes [in] and [not_in] with a comma-separated list.

  • filter[author_id]string (uuid)#

    Counters made by this user. Takes [in] and [not_in] with a comma-separated list.

  • filter[status]string#

    Counters in this status: pending, complete, declined or signed. Takes [in] and [not_in] with a comma-separated list.

    One of: pending, complete, declined, signed
  • filter[parent_id]string (uuid)#

    Counters that reply to this counter. Send filter[parent_id][null]=true for the first counter of each chain. Takes [in] and [not_in] with a comma-separated list.

  • 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.

CounterVersion[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "document_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "counter_document_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "parent_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "author_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "comment": "string",
      "feedback": "string",
      "status": "pending",
      "locked": true,
      "contract_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/counter-versions\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"