List qualification sessions with filtering and pagination
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): filter Qualification Sessions by status. The supported values and their meanings are listed in the parameter's description below.
- 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
Request
- Base URL: https://dev-api.truemed.com
- URL: https://dev-api.truemed.com/api/v1/qualification_sessions
- Auth: API key in header x-truemed-api-key
Query parameters
Optional field indicating which page to access. Defaults to 1.
Optional field indicating the number of records per page. Defaults to 30.
An optional user_id to search for.
An optional filter to only return sessions with the given status. One of:
- pending — The session was created; the shopper hasn't completed the survey yet.
- processing — The shopper completed the survey and it is under review.
- approved — The shopper holds a valid Letter of Medical Necessity covering the items in this order.
- rejected — The shopper is ineligible for a Letter of Medical Necessity for the items in this order.
Filter by expiration date (YYYY-MM-DD format)
Search across user name, email, user_business_id, utm, and external_user_id fields.
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.