List Truemed Sessions

Browse your channel’s Truemed sessions, newest first, for reconciliation and operational dashboards. Filter by status, date, or free-text search to narrow the set. Rows carry lean scalar fields so large result sets stay fast; fetch a session’s detail for its line items and capture history.

Authentication

x-truemed-api-keystring

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

Query parameters

pageintegerOptional
Page number to return. Defaults to 1.
page_sizeintegerOptional

Number of records per page. Defaults to 30; maximum 100.

user_idstringOptional

Filter to sessions for one of your customers, by the user_id you set at creation.

qualification_statuslist of stringsOptional
Filter to sessions in one or more qualification statuses, as a comma-separated list. One of: - `pending_user_intake` — The session was created; the shopper hasn't completed intake yet. - `pending_authorization` — Intake is done — or was never needed — and the session is parked here until you signal an authorization hold (or report a capture); that is what starts clinical review. - `pending_truemed_review` — Intake is complete and the session is under clinician review. - `approved` — The shopper holds a valid Letter of Medical Necessity covering the items in this order. - `partially_approved` — Review approved the shopper, but only part of the cart is HSA/FSA-eligible; the qualified per-item split is on order_items. - `rejected` — The shopper is ineligible for a Letter of Medical Necessity for the items in this order (including a cart that is entirely HSA/FSA-ineligible, which has no qualification path). - `canceled` — The session was canceled before completion; no further qualification or capture activity will occur.
searchstringOptional

Free-text match across session ID, your user_id, and the customer’s email and name.

created_fromdatetimeOptional

Return sessions created at or after this time (ISO 8601).

created_todatetimeOptional

Return sessions created at or before this time (ISO 8601).

captured_fromdatetimeOptional

Return sessions with a reported capture at or after this time (ISO 8601).

captured_todatetimeOptional

Return sessions with a reported capture at or before this time (ISO 8601).

Response

Successful response
paginationobject
A pagination object with information about the current page, page size, total count, and last page.
truemed_sessionslist of objects
Truemed sessions for the authenticated channel.

Errors

400
Bad Request Error
404
Not Found Error
405
Method Not Allowed Error
500
Internal Server Error
501
Not Implemented Error