# Hireflix API Documentation

This is the complete API documentation for connecting to the Hireflix API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Hireflix connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/hireflix/actions/{actionSlug}/run
```

## Hireflix actions

- POST `add-interview-comment` Add Interview Comment
- PUT `archive-interview` Archive Interview
- POST `create-interview-share-link` Create Interview Share Link
- POST `create-webhook` Create Webhook
- GET `get-current-user-info` Get Current User Info
- GET `get-interview` Get Interview
- GET `get-interview-candidate` Get Interview Candidate
- GET `get-interview-scores` Get Interview Scores
- GET `get-interview-thumbnails` Get Interview Thumbnails
- GET `get-interview-tracking` Get Interview Tracking
- GET `get-interview-user-metadata` Get Interview User Metadata
- GET `get-permissions` Get Permissions
- GET `get-position` Get Position
- GET `get-position-interview-stats` Get Position Interview Stats
- GET `get-position-public-submission-settings` Get Position Public Submission Settings
- GET `get-template` Get Template
- GET `get-theme` Get Theme
- GET `get-usage` Get Usage
- GET `get-webhook` Get Webhook
- GET `get-webhook-secret-key` Get Webhook Secret Key
- POST `invite-candidate-to-interview` Invite Candidate To Interview
- GET `list-api-keys` List API Keys
- GET `list-interview-comments` List Interview Comments
- GET `list-interview-steps` List Interview Steps
- GET `list-position-interviews` List Position Interviews
- GET `list-position-questions` List Position Questions
- GET `list-position-shareable-links` List Position Shareable Links
- GET `list-position-tags` List Position Tags
- GET `list-position-users` List Position Users
- GET `list-positions` List Positions
- GET `list-tags-for-position` List Tags for Position
- GET `list-templates` List Templates
- GET `list-themes` List Themes
- GET `list-webhook-logs` List Webhook Logs
- GET `list-webhooks` List Webhooks
- PUT `mark-interview-finalist` Mark Interview Finalist
- DELETE `remove-interview-share-link` Remove Interview Share Link
- PUT `score-interview` Score Interview
- PUT `set-interview-external-id` Set Interview External ID
- PUT `update-webhook` Update Webhook