Skip to main content
GET
List appointments on a med case

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Path Parameters

caseId
string<uuid>
required

Med case UUID

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
limit
integer
default:20

Results per page (max 100)

Required range: 1 <= x <= 100
medReferralId
string<uuid>
attended
enum<string>

null = no outcome recorded

Available options:
true,
false,
null
cancelled
enum<string>

Manual cancellation or Premier CANCELLED

Available options:
true,
false
source
enum<string>
Available options:
manual,
premier
dateFrom
string<date>

Inclusive

dateTo
string<date>

Inclusive

Response

Appointments, newest date first

data
object[]
required
pagination
object
required
meta
object
required