> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hireflix.com/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 managing job positions, to inviting candidates and reviewing their interviews. Click any step to open the detailed tutorial and GraphQL examples.

> [!NOTE]
>
> A **position** is a job opening you're hiring for, such as "Senior Backend Engineer". Candidates are invited to a position to complete a video interview, and each submission then shows up as an **interview** in that position's interview list.
>
> In other words, you always need a position before you can create interviews for it.

## Position Management

Use these endpoints to manage position data and keep your system synchronized with Hireflix.

> [card] [Create a Position](https://docs.hireflix.com/tech/features/positions/creating-position.md)
>
> Use the `createPosition` mutation to set up a new position — name, questions, outro, optional intro/outro/question videos, and [image prompt questions](https://docs.hireflix.com/tech/features/positions/image-prompt-questions.md) — directly from your system.

> [card] [Fetch Positions](https://docs.hireflix.com/tech/features/positions/fetching-positions.md)
>
> Retrieve a list of all open and archived positions. Typically used to populate dropdowns or match ATS job IDs to Hireflix positions.

> [card] [Update a Position](https://docs.hireflix.com/tech/features/positions/updating-position.md)
>
> Modify an existing position’s name using the `save` mutation. Useful when recruiters edit position details directly from your system.

> [card] [Archive a Position](https://docs.hireflix.com/tech/features/positions/archiving-position.md)
>
> 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] [Delete a Position](https://docs.hireflix.com/tech/features/positions/deleting-position.md)
>
> 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.

## Interview Flow

Once a position exists, the interview flow covers the full lifecycle of a candidate interview for that position, from invitation to review. Each step below corresponds to a key API feature.

> [card] [Invite a Candidate](https://docs.hireflix.com/tech/features/interviews/inviting-candidate.md)
>
> 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] [Create a Shareable Link](https://docs.hireflix.com/tech/features/interviews/creating-shareable-link.md)
>
> 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] [List Interviews for a Position](https://docs.hireflix.com/tech/features/interviews/list-interviews-for-position.md)
>
> 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] [Fetch Interview Results](https://docs.hireflix.com/tech/features/interviews/fetching-interview-results.md)
>
> Retrieve each candidate’s video responses and transcriptions. You’ll use this to display interview results directly inside your ATS or analytics dashboards.

> [card] [Score and Comment on Interviews](https://docs.hireflix.com/tech/features/interviews/scoring-and-commenting-interviews.md)
>
> Enable reviewers to leave feedback and assign scores via the `score` and `comment` mutations. Perfect for collaborative evaluations.

> [card] [Update Interview Stage](https://docs.hireflix.com/tech/features/interviews/updating-interview-status.md)
>
> 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] [Delete an Interview](https://docs.hireflix.com/tech/features/interviews/deleting-interview.md)
>
> Remove an interview with the `deleteInterview` mutation, for example so you can re-invite the same candidate to a position. If you only want to reject a candidate, discard the interview instead.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.