Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Identifier returned by the corresponding authorized collection; use only a record visible to the signed-in patient.

Query Parameters

limit
integer
default:50

Page size; positive values above 200 are capped. Invalid/nonpositive values use the default.

Required range: 1 <= x <= 200
offset
integer
default:0

Number of messages to skip; invalid/negative values use zero.

Required range: x >= 0
ordering
enum<string>
default:-created_at

Creation-time ordering; unsupported values use newest first.

Available options:
created_at,
-created_at

Response

Paginated authorized messages.

count
integer
required

Total matching records before pagination.

Required range: x >= 0
next
string<uri> | null
required

URL of the next page, or null after the last page. May be null when unavailable.

previous
string<uri> | null
required

URL of the previous page, or null on the first page. May be null when unavailable.

results
object[]
required

Records in this page, in the documented collection order.