Skip to main content

Retrieve a candidate's step timeline

GET 

/v1/flows/:flow_id/candidates/:candidate_id/steps

Required scopeflows:readWhat are scopes?

What has happened to this candidate on each step they have reached: when it was scheduled, sent, replied to, bounced or skipped, and the tasks it raised. A step the candidate has not reached is absent rather than empty, and a step still awaiting review of its AI-written message is left out until it is approved.

Request​

Responses​

Timeline retrieved