Get an interview
GET/interviews/:interview_id
Returns one interview's status: whether the candidate still needs to book a time, has one booked, can start whenever they open the link, is interviewing right now, or has finished.
This never returns interview_url. A magic-link token can only be shown once, at creation (or from
Get a fresh interview link) — Tarkflo stores only its hash, so there is nothing
to read back. Poll this endpoint on whatever schedule suits you; it does no heavier work than any other read.
The role this key acts as needs the candidates:view permission.
Request
Responses
- 200
- 401
- 403
- 404
- 429
The interview.
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 interview with that ID in your workspace.
Too many requests. Wait for Retry-After seconds, then retry.
Response Headers
Seconds to wait before retrying.