> ## Documentation Index
> Fetch the complete documentation index at: https://hireflixsl.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Hireflix API Features Overview

This page helps you understand the main integration flows available in the Hireflix GraphQL API. Each section walks through a complete process: from inviting candidates and reviewing interviews, to managing job positions. Click any step to open the detailed tutorial and GraphQL examples.

## 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.

<Card title="Invite a Candidate" icon="1" horizontal href="/features/interviews/inviting-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.
</Card>

<Card title="Create a Shareable Link" icon="2" horizontal href="/features/interviews/creating-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.
</Card>

<Card title="List Interviews for a Position" icon="3" horizontal href="/features/interviews/list-interviews-for-position">
  Fetch all interviews associated with a position. This lets your app display all candidates and their current interview stages (e.g. `to_evaluate`, `shortlisted`, `discarded`, or `pending`).
</Card>

<Card title="Fetch Interview Results" icon="4" horizontal href="/features/interviews/fetching-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.
</Card>

<Card title="Score and Comment on Interviews" icon="5" horizontal href="/features/interviews/scoring-and-commenting-interviews">
  Enable reviewers to leave feedback and assign scores via the `score` and `comment` mutations. Perfect for collaborative evaluations.
</Card>

<Card title="Update Interview Stage" icon="6" horizontal href="/features/interviews/updating-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 stages perfectly in sync.
</Card>

## 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](https://admin.hireflix.com/).

<Card title="Fetch Positions" icon="1" horizontal href="/features/positions/fetching-positions">
  Retrieve a list of all open and archived positions. Typically used to populate dropdowns or match ATS job IDs to Hireflix positions.
</Card>

<Card title="Update a Position" icon="2" horizontal href="/features/positions/updating-position">
  Modify an existing position’s name using the `save` mutation. Useful when recruiters edit position details directly from your system.
</Card>

<Card title="Archive a Position" icon="3" horizontal href="/features/positions/archiving-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.
</Card>

<Card title="Delete a Position" icon="4" horizontal href="/features/positions/deleting-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.
</Card>