---
title: "List Applicants"
method: GET
path: "/workflow_sessions/{workflowSessionId}/applicants"
tags: ["Applicant"]
---

# List Applicants

`GET /workflow_sessions/{workflowSessionId}/applicants`

Returns the list of all Applicants for a given Workflow Session.

## Path parameters

- `workflowSessionId` string, uuid, required — The unique identifier for a resource.

## Query parameters

- `after` string
- `limit` integer
- `status` 'initiated' | 'notified' | 'processed'

## Response `200`

OK

- GetWorkflowSessionsIdApplicants200Response
  - `meta` Pagination — Metadata about the response.
    - `next_cursor` string, nullable, required — Token to get the next page of results. If `null`, there are no more pages.
  - `data` WorkflowSessionApplicantListItem[]
    - `id` string, uuid, required — Unique identifier of the Applicant.
    - `workflow_session_id` string, uuid, required — Unique identifier of the Workflow Session.
    - `status` 'initiated' | 'notified' | 'processed', required — Status of the Applicant.
    - `label` string, required — Label of the Applicant.
    - `reference_id` string, nullable, required — Unique applicant identifier as registered on your side.
    - `delivery_mode` 'none' | 'email', required — Delivery mode to notify Applicants.
    - `email` string, email, nullable, required — Preferred email address for managing notifications, required if delivery_mode is set to email.
    - `created_at` string, date-time, required — Creation date of the Applicant.
    - `updated_at` string, date-time, required — Last update date of the Applicant.
    - `type` 'natural_person' | 'legal_person', required — Type of the Applicant.

## Other responses

- `400` — Bad request
- `401` — Access unauthorized
- `403` — Access forbidden
- `405` — This method is not allowed
- `429` — Too Many Requests, please try again later.
- `500` — Internal Server Error

---

[API](https://skmtc.net/yousign/apis/public-api-v3.md) · [All operations](https://skmtc.net/yousign/apis/public-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yousign/public-api-v3/revisions/8d258c0b45d6/schema)