Skip to main content

List all candidates in a flow

GET 

/v1/flows/:flow_id/candidates

Required scopeflows:readWhat are scopes?

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​

Candidates retrieved