Introduction
We have a set of APIs designed to enable the automation of repetitive tasks such as test administration and fetching results. Companies use our API to generate dashboards or integrate their bespoke HR systems. Note that we have pre-built integrations with some popular Applicant Tracking Systems. If you already use one of them, you may not need to use our API directly. Please find out more about our existing ATS integrations here.
Fetching your Personal Access Token
To get started with using our API, you will need an access token. Every Enterprise user with a HackerRank for Work account has a unique personal access token available in their account settings, which can be used to access the API. The following screenshot shows how to find and access token in your account:
Please note that this token should not be used for our Official ATS Integrations.
Available APIs
The following table lists the different APIs we have and what you can do with them. Most of our customers use the Tests and Interview APIs. The others in the list are for niche use cases, and at this time, they are used chiefly by our internal teams.
| Sl.No | API Name | Link to Technical Documentation | Notes on Use Cases |
| 1 | Tests API | Documentation here. | Most popular with our existing customers. The calls in this API allow you to perform repetitive tasks about the Tests module - like inviting candidates for a test, fetching candidate status, including detailed reports, viewing details about tests and the contained questions, etc. |
| 2 | Interviews API | Documentation here | Allow such actions to create a new QuickPad, schedule an interview, view all interviews, fetch reports, etc. |
API Console
If you are a developer curious to try out our API, you should go to the Console for the respective API. The links are given in the table above. The console also has basic information on the required parameters and other such documentation. See the other pages here for some additional documentation that we could not fit on the API console.