List Qualification Sessions

Returns a paginated view of all Qualification Sessions associated with the API key used in the request header, sorted by their created_at date. Optional search fields are provided to aid in finding the session or sessions associated with a given user.

Request Notes

Query Params:

status (Optional): enum - filter Qualification Sessions by one of the following values:
- pending - incomplete sessions (the user hasn’t finished the survey)
- processing - survey answers are under review
- approved - the user qualified
- rejected - the user did not qualify
page (Optional): int - the page to retrieve, defaults to 1. 30 entries are returned per page.

Response Notes

Bad Request

HTTP Status: 400

If a field is missing or the request otherwise can’t be processed, we’ll return a 400 with the following fields:

error: Can be one of:
- ValidationError: invalid request
message: Details on how the request was invalid

Returns a paginated view of all Qualification Sessions associated with the API key used in the request header, sorted by their `created_at` date. Optional search fields are provided to aid in finding the session or sessions associated with a given user. ## Request Notes Query Params: - `status` (Optional): enum - filter Qualification Sessions by one of the following values: - `pending` - incomplete sessions (the user hasn't finished the survey) - `processing` - survey answers are under review - `approved` - the user qualified - `rejected` - the user did not qualify - `page` (Optional): int - the page to retrieve, defaults to 1. 30 entries are returned per page. ## Response Notes ### Bad Request HTTP Status: 400 If a field is missing or the request otherwise can't be processed, we'll return a 400 with the following fields: - **error**: Can be one of: - `ValidationError`: invalid request - **message**: Details on how the request was invalid

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Query parameters

pageintegerOptional

Optional field indicating which page to access. Defaults to 1.

page_sizeintegerOptional

Optional field indicating the number of records per page. Defaults to 30.

user_idstringOptional

An optional user_id to search for.

statusstringOptional

An optional filter to only return supplied status(es). Can supply multiple separated by commas. Statuses: pending, processing, approved, rejected.

expires_atdatetimeOptional

Filter by expiration date (YYYY-MM-DD format)

Response

Successful response

qualification_sessionslist of objects

An array of qualification_session objects.

paginationobject

A pagination object with information about the current page, page size, total count, and last page.

Errors

400

Bad Request Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error

501

Not Implemented Error