Skip to main content
GET
List patient appointments

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

practice_id
string
required

Practice ID.

patient_ids
string[]

One or more patient IDs.

booked_by_patient_ids
string[]

One or more IDs for patients or clients who booked the appointment.

appointment_start_at_after
string<date-time>

Return appointments starting at or after this timestamp.

appointment_start_at_before
string<date-time>

Return appointments starting at or before this timestamp.

status
string[]

Limit results to one or more appointment statuses.

fetch_from_source
boolean
default:true

Refresh appointments from the connected practice-management system.

sync_latest_only
boolean
default:false

When refreshing, limit synchronization to the latest appointments.

page
integer

Page number.

Required range: x >= 1
page_size
integer

Number of records to return per page.

Required range: x >= 1

Response

Paginated appointments.

count
integer
required

Total number of matching records.

results
object[]
required
next
string<uri> | null

URL for the next page, when available.

previous
string<uri> | null

URL for the previous page, when available.