Hireflix API Documentation

This is the complete API documentation for connecting to the Hireflix API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Hireflix: Invite candidates, review interviews, and manage hiring workflows. Keep reading to get started.

Quickstart

Before you run your first Hireflix request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Hireflix connection — create or choose one in Connections. Note its connectionId.

Every Hireflix action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/hireflix/latest/actions/{actionSlug}

You need a MindCloud API Key and a Hireflix connection. Then call an action such as Get Current User Info:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/hireflix/latest/actions/get-current-user-info" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Hireflix account that should run the action. MindCloud stores and refreshes the Hireflix credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Hireflix actions

All 40 published actions for this Hireflix version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Interview Comment
• PUTArchive Interview
• POSTCreate Interview Share Link
• POSTCreate Webhook
• GETGet Current User Info
• GETGet Interview
• GETGet Interview Candidate
• GETGet Interview Scores
• GETGet Interview Thumbnails
• GETGet Interview Tracking
• GETGet Interview User Metadata
• GETGet Permissions
• GETGet Position
• GETGet Position Interview Stats
• GETGet Position Public Submission Settings
• GETGet Template
• GETGet Theme
• GETGet Usage
• GETGet Webhook
• GETGet Webhook Secret Key
• POSTInvite Candidate To Interview
• GETList API Keys
• GETList Interview Comments
• GETList Interview Steps
• GETList Position Interviews
• GETList Position Questions
• GETList Position Shareable Links
• GETList Position Tags
• GETList Position Users
• GETList Positions
• GETList Tags for Position
• GETList Templates
• GETList Themes
• GETList Webhook Logs
• GETList Webhooks
• PUTMark Interview Finalist
• DELETERemove Interview Share Link
• PUTScore Interview
• PUTSet Interview External ID
• PUTUpdate Webhook

Related apps

More Human Resources apps on the Universal API, behind the same REST shape. Or browse all apps.

LinkedInClockifyConnecteamBambooHRTalentLMSCertifierZoho RecruitMemberVault