API ReferenceTruemed Sessions

List Shop Pay 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

Platform API key for platform 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 complete and the session is waiting for you to 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` — A clinician approved every item that went to review, and the shopper now holds a valid Letter of Medical Necessity for the qualified items in this order. Items that were already ineligible at creation stay ineligible; see the per-item order_items breakdown for what qualified. - `rejected` — No qualifying items in this order. Either a clinician declined the request, or an item that started out eligible failed review. A cart with no HSA/FSA-eligible items lands here too, since there is nothing for a clinician to review. - `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