search parameter, which matches against name, CPF, and phone number, or filter by health plan and registration date. Use the next_cursor value from each response to walk through subsequent pages.
Endpoint
Authentication
Include your API key in theAuthorization header on every request:
Query Parameters
integer
default:"20"
Maximum number of patient records to return per page. Accepted range is
1–100.string
Opaque pagination cursor returned as
next_cursor in the previous response. Omit this parameter to start from the beginning of the list.string
Free-text search string. Matched case-insensitively against the patient’s full name, CPF, and phone number. Partial matches are supported.
string
Filter results to patients enrolled in a specific health insurance plan. The value must match the
health_plan field exactly (case-insensitive).string
Return only patients created after this ISO 8601 UTC timestamp, e.g.
2024-01-01T00:00:00Z. Useful for incremental syncs.Response Fields
data array — Patient object
string
required
Unique identifier for the patient (UUID v4).
string
required
Identifier of the clinic this patient belongs to.
string
required
Patient’s full name.
string
Brazilian individual taxpayer identifier in the format
123.456.789-00. Present only if recorded.string
Contact phone number in E.164 format, e.g.
+5511999999999.string
Patient’s email address.
string
Date of birth in
YYYY-MM-DD format.string
Name of the patient’s health insurance plan.
boolean
required
true if the patient has opted out of WhatsApp notifications from your clinic.string
required
ISO 8601 UTC timestamp of when the patient record was created.
string
required
ISO 8601 UTC timestamp of when the patient record was last modified.
meta object
integer
required
Total number of patients matching the current query filters.
boolean
required
true if there are additional pages of results beyond the current response.string
Cursor value to pass as the
cursor query parameter on your next request. Present only when has_more is true.CPF is a sensitive personal identifier protected under Brazil’s Lei Geral de Proteção de Dados (LGPD). Treat it with the same care as any government-issued ID — avoid logging CPF values in plain text, and limit access to this field to authorised personnel only.