Skip to main content
GET
List data requests

Authorizations

Authorization
string
header
default:Bearer sandbox_any_token_works
required

A brand's server, one OAuth client per brand and environment. Get a token with the client_credentials grant and send it as Authorization: Bearer <token>. Tokens last 1 hour. A brand server reads status and ids only; it never reads clinical content. A platform partner holds one client for all its brands and gets one token per brand, naming it with tenant_id.

Query Parameters

status
enum<string>
Available options:
received,
processing,
completed,
rejected
Example:

"processing"

kind
enum<string>
  • export: a copy of the patient's coaching records for your brand, as a download.
  • delete: removes the patient's coaching records for your brand, except what the law requires TeraRx to keep (the audit log).
  • amend: the HIPAA right to amend. You decide within 60 days of requested_at.
Available options:
export,
delete,
amend
Example:

"export"

enrollment_id
string<uuid>
limit
integer
default:25

Page size.

Required range: 1 <= x <= 100
cursor
string

The next_cursor from the previous page. Omit it for the first page.

Maximum string length: 512

Response

A page of data requests.

data
object[]
required
next_cursor
string | null
required

Pass it back as cursor for the next page. null on the last page.

Example:

"eyJpZCI6IjAxOTBmNWMyIn0"