List all candidates in a flow
GET/v1/flows/:flow_id/candidates
Lists the candidates in the flow. meta also carries counts_by_status and counts_by_pause_reason over exactly the set the filters select, not just the page. Filtering by status therefore leaves only that status in counts_by_status, so read them as a facet panel with no status filter applied.
Request
Responses
- 200
- 401
- 403
- 404
- 422
Candidates retrieved
Missing or invalid bearer token.
The public API is not enabled for this account (err_feature_not_enabled), the acting user is not allowed to view this flow, or the API key lacks the flows:read scope (err_insufficient_scope).
Flow not found (err_flow_not_found).
Validation failed. For example an unknown status or a one-character query.