📄 API Reference

This guide tells you how Equip's REST APIs can be used, the resources it contains and so on.

Authentication

For Authentication, you will receive an API key once you create a team on Equip, and make a minimum purchase as explained here.

Once you have the API key, all the API requests made should contain the Authorization header, and its value must be EQP {API_KEY}

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Restricting fields in responses

In all GET requests, the fields to be returned can be selected. This can be done using the fieldsquery parameter, and separating the fields by commas. The requested fields must be one of the attributes defined in the resource.

For example, GET https://equip.co/api/v2/assessments/?fields=number,titlereturns only the number and title fields of each assessment.

Not specifying any fields returns all the fields defined in the resource.

Filtering results

You can refine the results of your GET requests by applying filters using query parameters in the format field[operator]=value. Supported operators include eq (equals), neq (not equals), lt (less than), lte (less than or equal to), gt (greater than), gte (greater than or equal to), isnull, and isnotnull. Only the filter fields defined for a resource can be used.

For example, GET https://equip.co/api/v2/assessments/?status[eq]=activewill return all the assessment whose status is active

Expanded fields

For certain related objects, you can retrieve additional details by using the expand query parameter. This parameter allows you to include related resources directly in the response. You can also include multiple expand objects by separating them by commas.

For example, GET https://equip.co/api/v2/assessments/asmt_label/?expand=testswill give you the fields from the assessment resource, and also all the tests associated with the assessment.

Resources