Qualified API Documentation

The API is currently in beta and as such is subject to change. If you have a request for a specific integration endpoint not documented here, please reach out to at
[email protected], or via our help feature within the app.

Base Path

All endpoints have a base path of https://www.qualified.io/api.

Authorization

Authorization is done by passing in an API key to the authorization header. If your account is on a plan that allows API access then you
will be able to find your key by going to Team Settings > Integrations within the Qualified app.

Note: The examples below may use a longer token string than the key you will find within your team account settings.

Note: Make sure to keep your API key safe. Do not expose it through client-side applications.

Parameters

There are a few special conventions used within our API in regards to our parameters:

Casing

Both camel and underscore casing is supported when sending data to the sever. The examples given will use underscore casing for consistency.

Includes

There is a special parameter called "includes", available on most model requests. This parameter will fetch additional relations related to each model
and include them within the model's JSON response.

Assessment Challenge Items

Create

This endpoint will pass a challenge id to a assessment and return a AssessmentChallengeItem record. If
the challenge already exists for the assessment, a 409 will be returned. If a global challenge
is passed, a copy of it will be created for the given team and that copy will be used
instead.

Create

Creates a new solution of the type specified. This is an alias endpoint for the subtype specific route.
See each type specific section for more details. For this example, this route is actually linking to the
POST /v1/code_solutions route.