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

# API Integration

> Seamlessly connect InterviewFlowAI with your existing ATS, CRMs, or internal tools.

Use this guide to seamlessly connect InterviewFlowAI with your existing Applicant Tracking Systems (ATS), CRMs, or internal tools. Proper integration ensures automated candidate ingestion, two-way data syncing, and real-time updates, creating a frictionless experience for both your hiring team and your candidates.

## How integrations work

In the Integrations flow, you configure core communication channels between InterviewFlowAI and your external systems:

| API / Feature              | Description                                                                                        |
| -------------------------- | -------------------------------------------------------------------------------------------------- |
| **Ingestion API**          | Push candidate data into InterviewFlowAI programmatically to trigger interview invitations.        |
| **Create Interviewer API** | Create new Interviewers with full interview configuration programmatically.                        |
| **Fetch API**              | Retrieve candidate lists, specific interview details, and filter records directly from our system. |
| **Patch API**              | Update custom fields and sync statuses back to candidate records in InterviewFlowAI.               |

## Getting started

<Steps>
  <Step title="Generate your API key">
    Before setting up any connections, you must authenticate your requests.

    1. Navigate to the **API Keys** section in your main dashboard settings.
    2. Click **Generate** to create a new secure API key.

    <Warning>
      **Requirement:** You must include this API key in the headers of all your API requests (Ingestion, Fetch, and Patch) to authenticate successfully. Keep this key secure.
    </Warning>
  </Step>

  <Step title="Access Interviewer-specific integrations">
    Integrations are scoped to specific Interviewers to ensure candidates are routed to the correct interview flow.

    1. Select your target Interviewer from the main dashboard.
    2. Click on **View Interviews**.
    3. Click on the **Integrations** tab.
  </Step>
</Steps>