API Integrations

What does an API Integration Mean?

We expose our REST APIs so that steps like creating an assessment, viewing the results of an assessment can be automated. The candidate will still attempt the assessment on the Equip website, but YOU needn't visit our website

The integration doesn't give you direct access to our questions. For example, you cannot just say, "Give me 100 Python MCQs". What you can do, though, is create an assessment with Python MCQs. When the candidate starts the assessment, questions are automatically picked from our Question Bank. Or if you have created Custom Tests, the candidates will see the tests one after another.

What does the integration cost?

By themselves, the integrations don't cost you anything extra, apart from a one-time setup fee. To get access to the integrations, you need to make a minimum monthly purchase of credits. These credits can be used towards assessments, exactly as outlined on our Pricing Page. Discounts, expiry, etc are the same as outlined there.

Integration Type	Minimum credit purchase	One-time Setup Fee
API-only	500 credits/month	$500

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

How do I get started with the Integration?

These are the steps:

Create a team if you haven't already
Test Equip with your free credits to see if you are satisfied with the product. Remember that even if you use the APIs, most aspects of the product remain the same
Make a minimum purchase on our website corresponding to the amount mentioned in the table above
Email or chat with us to get the API Key

What APIs are available?

We have enabled API access to two of our resources: Assessment and AssessmentProgress.

Assessment: Allows you to get all the assessments created by your team, all the tests within an assessment, generate assessment 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.

The APIs we have available are listed below:

Assessment

All Assessments - Returns a list of all the assessments created by your team.
Assessment Tests - Returns a list of all the tests in an assessment.
All Assessment Progress of an Assessment - Returns a list of all AssessmentProgress records for an assessment. This contains details such as the overall scores, time at which candidates' finished an assessment and so on.
Invite to Assessment - Given a list of user details, this API emails one-time assessment invitation URLs to each of the users.
Generate Invitation URLs - Given a list of email IDs, this API returns a list of assessment invitation URLs, which can then be shared with candidates. Useful if you do not want Equip to send the emails for you.

AssessmentProgress

All Assessment Progress - Returns a list of all AssessmentProgress records for a team. Can be filtered by asmt_label to get the records specific to one assessment.
Test Attempts for an Assessment Progress - Returns a list of TestAttempts, which contain the details of a candidate attempting a specific test, for all tests in an assessment attempted by a particular candidate.

Updated on: 20/01/2025