Get a workflow
GET/workflows/:workflow_id
Returns one workflow: its rounds in order, with each round's name, kind and template, and the jobs that run through it.
A round's type is interview for a round candidates are interviewed in, and otherwise the kind of stage, such
as a call, an assignment or an offer. An interview round also says how it is run: screening is a set of
questions, and two_way is a live conversation. An interview round names its template by template_id, which
you read with Get a template. Its pass marks and advance rules stay in the dashboard and
are not returned.
The role this key acts as needs the templates:view permission.
Request
Responses
- 200
- 401
- 403
- 404
- 429
The workflow.
Response Headers
Requests allowed in the current window for this key.
Requests left in the current window.
The key is missing, malformed, expired or revoked.
The key is valid but may not do this: the role it acts as lacks the permission this call needs (forbidden,
with the permission in required), or the workspace's plan has lapsed (billing_past_due: reads still work,
adding candidates is paused) or is suspended (account_suspended).
There is no workflow with that ID in your workspace.
Too many requests. Wait for Retry-After seconds, then retry.
Response Headers
Seconds to wait before retrying.