---
title: "List all submitters"
method: GET
path: "/submitters"
tags: ["Submitters"]
---

# List all submitters

`GET /submitters`

The API endpoint provides the ability to retrieve a list of submitters.

## Query parameters

- `submission_id` integer
- `q` string
- `slug` string
- `completed_after` string, date-time
- `completed_before` string, date-time
- `external_id` string
- `limit` integer
- `after` integer
- `before` integer

## Response `200`

OK

- object
  - `data` object[]
    - `id` integer, required — Submitter unique ID number.
    - `submission_id` integer, required — Submission unique ID number.
    - `uuid` string, required — Submitter UUID.
    - `email` string, required — The email address of the submitter.
    - `slug` string, required — Unique key to be used in the form signing link and embedded form.
    - `sent_at` string, nullable, required — The date and time when the signing request was sent to the submitter.
    - `opened_at` string, nullable, required — The date and time when the submitter opened the signing form.
    - `completed_at` string, nullable, required — The date and time when the submitter completed the signing form.
    - `declined_at` string, nullable, required — The date and time when the submitter declined the signing form.
    - `created_at` string, required — The date and time when the submitter was created.
    - `updated_at` string, required — The date and time when the submitter was last updated.
    - `name` string, nullable, required — The name of the submitter.
    - `phone` string, nullable, required — The phone number of the submitter.
    - `status` 'completed' | 'declined' | 'opened' | 'sent' | 'awaiting', required — The status of signing request for the submitter.
    - `external_id` string, nullable, required — Your application-specific unique string key to identify this submitter within your app.
    - `preferences` object, required — Submitter preferences.
    - `metadata` object, required — Metadata object with additional submitter information.
    - `submission_events` object[], required — An array of events related to the submission.
      - `id` integer, required — Submission event unique ID number.
      - `submitter_id` integer, required — Unique identifier of the submitter that triggered the event.
      - `event_type` 'send_email' | 'bounce_email' | 'complaint_email' | 'send_reminder_email' | 'send_sms' | 'send_2fa_sms' | 'open_email' | 'click_email' | 'click_sms' | 'phone_verified' | 'start_form' | 'start_verification' | 'complete_verification' | 'view_form' | 'invite_party' | 'complete_form' | 'decline_form' | 'api_complete_form', required — Event type.
      - `event_timestamp` string, required — Date and time when the event was triggered.
      - `data` object — Additional event details object.
    - `values` object[], required — An array of pre-filled values for the submitter.
      - `field` string, required — Document template field name.
      - `value` union, required — Pre-filled value of the field.
        - string
        - number
        - boolean
        - union[]
          - union
            - string
            - number
            - boolean
    - `documents` object[], required — An array of completed or signed documents by the submitter.
      - `name` string, required — Document name.
      - `url` string, required — Document URL.
    - `role` string, required — The role of the submitter in the signing process.
  - `pagination` object
    - `count` integer, required — Submitters count.
    - `next` integer, nullable, required — The ID of the submitter after which the next page starts.
    - `prev` integer, nullable, required — The ID of the submitter before which the previous page ends.

---

[API](https://skmtc.dev/keyring-network/apis/keyring-docsign-api.md) · [All operations](https://skmtc.dev/keyring-network/apis/keyring-docsign-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/keyring-network/keyring-docsign-api/revisions/5381dc74855a/schema)