Signatures

List signature requests on a folder

GET/folders/{folder_id}/signatures
signatures:readlist_folder_signaturesRead-onlyDeprecatedSunset 2027-06-30

Lists the signature requests made on a folder, on anything inside it, or on a document in it, newest first, in the shape of GET /signature-requests. 404 when the folder is unknown or the caller cannot read it. The earlier signatoryId, signatoryType and limit parameters still work. Changes nothing. Deprecated: use GET /signature-requests?filter[within_folder_id]=. Withdrawn on 2027-06-30. Responses carry Deprecation, Sunset and a successor Link.

Path parameters

  • folder_idstring (uuid)Required#

    The folder'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[signatory_id]string (uuid)#

    Requests with a live signature for this user or group id. Takes [in] and [not_in] with a comma-separated list.

  • filter[signatory_type]string#

    Requests with a live signature for a signatory of this kind: user, group, multi_user or machine. Takes [in] and [not_in] with a comma-separated list.

    One of: user, group, multi_user, machine

Responses

200

One page of records.

SignatureRequest[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "document_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "folder_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "type": "wet_ink",
      "strategy": "one_for_all",
      "state": "not_started",
      "signature_counts": {},
      "requested_by": {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "type": "string"
      },
      "origin": "string",
      "docusign_template_ids": [
        "string"
      ],
      "docusign_template_only": true,
      "docusign_require_2fa": true,
      "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/folders/{folder_id}/signatures\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"