Get started in three steps
Hireflix provides a GraphQL API that allows you to integrate one-way video interview functionality into your own systems. Using the Hireflix API, you can programmatically invite candidates to interviews, track interview progress, and retrieve video responses. Watch the quickstart video or follow the steps below:You can try any query or mutation in the Hireflix Dev Playground, which sends requests to the Hireflix API at
https://api.hireflix.com/me.1
Create a Hireflix Account
The easiest way to authenticate is with an API Key. Every Hireflix account can generate API keys, which carry your account permissions and should be kept secure. First, you need to sign up via the Hireflix website.

2
Create an API Key
Log in to your Hireflix account, open your profile by clicking on your name at the top right of your screen, and navigate to the API Keys section. From there, create your first API key and give it a label so you can easily recognize it later.

3
Send your first API request (Dev Playground)
All requests to the Hireflix API (Open the Hireflix Dev PlaygroundThe easiest way to try the API without writing code is the Hireflix Dev Playground. It lets you run any query or mutation against your own account and create sample data, so you can experiment and learn quickly.
Follow the tutorialThe first time you open the playground, a tutorial starts. It walks you through every step and helps you generate demo data in your account, so you can try out all queries and mutations. If it doesn’t start, click the Tutorial button in the top right.Add your API key and run your first queryPaste your API key into the API key field at the top and click Save. You can now run any query or mutation against your account.
Open Examples in the left menu. It lists all queries and mutations referenced in these docs. If you skipped the tutorial, start with the first example, Click the Play button. You should see your Hireflix account details appear in the response panel. 🎉 Success!
https://api.hireflix.com/me) require authentication. Add your API key to the request headers as shown below:

getBasicInfo:What should I learn next?
Explore the GraphQL basics, or learn about interview and position management. Later, webhooks can help you trigger actions when events occur.Unfamiliar with GraphQL?
Get a quick introduction to GraphQL and learn the difference between queries and mutations.
Interview Management
Explore the full interview flow: from inviting candidates to reviewing completed interviews.
Position Management
Learn how to create, update, and organize positions (jobs).
Webhooks
Discover how to use webhooks to trigger actions when events occur, like when a candidate finishes an interview.

