v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Signature Request

List Signature Requests

Returns the list of all Signatures Requests in your organization. You can limit the number of items returned by using filters and pagination. Consult our guide for more details and examples.

get/signature_requests

Query parameters

afterstring

After cursor (pagination)

limitinteger

The limit of items count to retrieve.

statusobject

Filter by status.

Filter by status. Allowed operators: eq, in. Example: status[in]=draft,done

created_atobject

Filter by date of creation.

Filter by created_at. Allowed operators: eq, between, before, after. Format: the date format required is yyyy-mm-dd Example: created_at[between]=2025-03-02,2025-03-04

activated_atobject

Filter by activation date.

Filter by activated_at. Allowed operators: eq, between, before, after. Format: the date format required is yyyy-mm-dd Example: activated_at[after]=2025-03-01

completed_atobject

Filter by completion date.

Filter by completed_at. Allowed operators: eq, between, before, after. Format: the date format required is yyyy-mm-dd Example: completed_at[between]=2025-03-01,2025-03-31

approved_atobject

Filter by approval date.

Filter by approved_at. Allowed operators: eq, between, before, after. Format: the date format required is yyyy-mm-dd Example: approved_at[after]=2025-03-01

rejected_atobject

Filter by rejection date.

Filter by rejected_at. Allowed operators: eq, between, before, after. Format: the date format required is yyyy-mm-dd Example: rejected_at[before]=2025-04-01

declined_atobject

Filter by decline date.

Filter by declined_at. Allowed operators: eq, between, before, after. Format: the date format required is yyyy-mm-dd Example: declined_at[after]=2025-01-01

workspace_idobject

Filter by workspace_id.

Filter by workspace_id. Allowed operators: eq. Example: workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748

external_idobject

Filter by external_id.

Filter by external_id. Allowed operators: eq. Example: external_id[eq]=an-external-id

sourceobject

Filter by source.

Filter by source. Allowed operators: eq, in. Default value: source[eq]=public_api. If not specified, only Signature Requests created via the Public API are returned. Example: source[in]=public_api,app

qstring

Search on name

label.nameobject

Case sensitive filter by Label's name.

Filter by Label's name. Allowed operators: eq, in. Example: label.name[in]=To Sign,Miscellaneous

Response

Example response

{
  "data": [
    {
      "id": "89120884-d29a-4b1a-ac7b-a9e73a872795",
      "name": "signature request name",
      "created_at": "2024-01-18T22:59:00Z",
      "activated_at": "2024-01-18T22:59:00Z",
      "completed_at": "2024-01-18T22:59:00Z",
      "approved_at": "2024-01-18T22:59:00Z",
      "timezone": "Europe/Paris",
      "email_custom_note": "Please sign these documents as soon as possible.",
      "expiration_date": "2024-01-18T22:59:00Z",
      "labels": [
        {
          "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
          "name": "Contracts"
        }
      ],
      "external_id": "An_external-ID",
      "branding_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
      "custom_experience_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
      "signers_allowed_to_decline": true,
      "workspace_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
      "audit_trail_locale": "en",
      "bulk_send_batch_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
      "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
      "previous_attempt_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde4",
      "custom_properties": [
        {
          "type": "text",
          "workspace_ids": [
            "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
          ]
        }
      ]
    }
  ]
}