Signatures

List DocuSign templates

GET/docusign-templates
signatures:readlist_docusign_templatesRead-only

Lists the templates in the organisation's DocuSign account as {id, name}, live from DocuSign with the enabled e-sign configuration. Use the ids in docusign_template_ids. Pass next_cursor back with the same limit; a foreign cursor returns 422 invalid_cursor. Returns 409 invalid_state when no DocuSign configuration is enabled, and 502 upstream_error when DocuSign rejects, times out or answers badly. Changes nothing. The scope maps to PERM_CAN_MANAGE_DOCUMENT_SETTINGS; the legacy listing also required the editor role.

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.

Responses

200

One page of DocuSign templates.

DocusignTemplate[]
{
  "data": [
    {
      "id": "0c1d2e3f-4a5b-4c6d-8e7f-90a1b2c3d4e5",
      "name": "Subscription Agreement"
    },
    {
      "id": "1d2e3f40-5b6c-4d7e-8f90-a1b2c3d4e5f6",
      "name": "Side Letter"
    }
  ],
  "meta": {
    "limit": 25,
    "next_cursor": null,
    "prev_cursor": null
  }
}
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
409

DocuSign is not configured for the organisation (error.code = invalid_state).

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
502

DocuSign did not answer: the token request or the template request failed, timed out or returned a malformed body (error.code = upstream_error).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/docusign-templates\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"