Applicant
List Applicants
Returns the list of all Applicants for a given Workflow Session.
get/workflow_sessions/{workflowSessionId}/applicants
Path parameters
workflowSessionIdstring uuid required
The unique identifier for a resource.
Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c
Workflow Session Id
Query parameters
afterstring
After cursor (pagination)
limitinteger
The limit of items count to retrieve.
status'initiated' | 'notified' | 'processed'
Filter Applicants by status.
Response
OK
Example response
{
"data": [
{
"id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
"workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
"status": "initiated",
"label": "John Doe",
"reference_id": "REF-12345",
"delivery_mode": "email",
"email": "applicant@example.com",
"created_at": "2024-01-18T22:59:00Z",
"updated_at": "2024-01-18T22:59:00Z",
"type": "natural_person"
}
]
}