Interview Flow
The interview flow represents the full lifecycle of a candidate interview, from invitation to review. Each step below corresponds to a key API feature.Invite a Candidate
Use the
inviteCandidateToInterview mutation to invite a candidate to a specific position from your system. This creates a new interview instance and sends an automatic email invitation.Create a Shareable Link
Generate a public link (using the
share mutation) so recruiters, clients, or teammates can view the candidate’s recording without logging into Hireflix. You can control how long the link remains active.List Interviews for a Position
Fetch all interviews associated with a position. This lets your app display all candidates and their current interview statuses (e.g. to evaluate, shortlisted, discarded).
Fetch Interview Results
Retrieve each candidate’s video responses and transcriptions. You’ll use this to display interview results directly inside your ATS or analytics dashboards.
Score and Comment on Interviews
Enable reviewers to leave feedback and assign scores via the
score and comment mutations. Perfect for collaborative evaluations.Update Interview Status
Move candidates between stages (e.g., mark as shortlisted or discarded) using the
finalist and archive mutations. This keeps your ATS and Hireflix statuses perfectly in sync.Position Management
Positions represent the interviews or roles that candidates apply for. Use these endpoints to manage position data and keep your system synchronized with Hireflix. Remember, positions can’t be created through the API, create them in the Hireflix Dashboard.Fetch Positions
Retrieve a list of all open and archived positions. Typically used to populate dropdowns or match ATS job IDs to Hireflix positions.
Update a Position
Modify an existing position’s name using the
save mutation. Useful when recruiters edit position details directly from your system.Archive a Position
Mark a position as closed (archived) once the hiring process is complete. Archived positions no longer appear in candidate selection lists, but they retain attached interview data.
Delete a Position
Completely remove a position from Hireflix when it’s no longer needed. However, use with care, as deleting a position also removes all associated interviews. It’s better to archive a position if you want to keep its data.