Skip to main content
GET
List all patient custom care reminders

Authorizations

Authorization
string
header
required

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

Query Parameters

ids
integer[] | null

When provided, filters to objects with these IDs.

ending_before
integer | null

A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as starting_after.

starting_after
integer | null

A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as ending_before.

limit
integer
default:10

The maximum number of items to return per page.

Required range: 1 <= x <= 100
is_deleted
enum<string>
default:FALSE

When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.

Available options:
FALSE,
TRUE,
ALL
clinic_client_id
integer | null

When provided, filters to reminders for the organization client to which the clinic client with this ID belongs. You must provide exactly one of clinic_client_id, organization_client_id, clinic_patient_id, or organization_patient_id.

organization_client_id
integer | null

When provided, filters to reminders for the organization client with this ID. You must provide exactly one of clinic_client_id, organization_client_id, clinic_patient_id,or organization_patient_id.

clinic_patient_id
integer | null

When provided, filters to reminders for the organization patient to which the clinic patient with this ID belongs. You must provide exactly one of clinic_client_id, organization_client_id, clinic_patient_id, or organization_patient_id.

organization_patient_id
integer | null

When provided, filters to reminders for the organization patient with this ID. You must provide exactly one of clinic_client_id, organization_client_id, clinic_patient_id, or organization_patient_id.

Response

200 - application/json

OK

data
ExternalPatientCustomCareReminderSchema · object[]
required

A single page of data contained within this list.

next_page
string
required

A URL linking to the next page of this list.

has_more
boolean
default:false

Whether there are more pages or data in this list.

type
string
default:list

Type of this object. Always list.