API Integrations

API Integration Overview

Say you want to integrate Equip within your ATS. Or you have an internal ATS-type system of your own and don't want to have to invite the candidates and look at the results manually. Our REST APIs can help you automate the process. The candidate will still attempt the assessment on the Equip website, but YOU needn't visit our website to manage the pipeline.

The integration doesn't give you direct access to our questions. For example, you cannot just say, "Give me 100 Python MCQs". But, if you can create an assessment with Python MCQs, the candidate sees questions that automatically picked from our Question Bank.

Costs

The integrations don't cost you anything extra per se. There are two components to enabling the integration:

A one-time setup fee of $500. This $500 will convert to 500 credits.
A minimum monthly purchase of 500 credits.

The credits can be used towards assessments, exactly as outlined on our Pricing Page. These credits never expire, just like other regular Equip credits. So, while you are purchasing credits for the integration, they are being consumed only for your regular usage purposes.

How do I get started with the Integration?

Create a team from this link
Test Equip with your free credits to see if the product works for you
Purchase $500 worth of credits on our website. (This is $500 worth of credits and not necessarily 500 credits. For example, say you end up getting a discount of 25% on your first purchase, you'll pay $375 for 500 credits. You'll need to purchase 667 credits to end up paying us $500.)
Email or chat with us to get the API Key
Ensure you continue to purchase at least 500 credits each month

What APIs are available?

There is a public Postman collection of our APIs. You will need an API key to actually use the APIs (see above).

We have enabled API access on

Assessment With this, you can get all the assessments created by your team, all the tests within an assessment, generate invitation links for an assessment and so on.
AssessmentProgress Tells you about a candidates attempting an Assessment. You can find the results of assessments by using the APIs in this resource.

Specific APIs

In particular, these are the different actions you can perform using our APIs

`Assessment`

Fetch a list of all the assessments created by your team
Fetch a list of all the tests in an assessment, their weightage, settings, etc
Get the candidate results of an assessment. This contains details such as the scores, time at which candidates' finished an assessment and so on
Invite candidates to an assessment. Given a list of email IDs, this API emails candidates with Assessment Invitation URLs
Generate Invitation URLs. Same as above, but doesn't email the candidates

`AssessmentProgress`

Fetch a list of all candidate submissions records for a team, across multiple assessments
Given an assessment progress ID, fetch the details of the candidate's individual test scores

Updated on: 27/04/2025

Was this article helpful?

Thank you!