List appointments

Request

Retrieve a paginated list of appointments for the account. Supports filtering by location, practitioner, patient, date range, and status. Results are sorted by appointment start time by default.

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query

practitionerIdinteger, (int64)

Filter by practitioner ID (staff member with a practitioner role)

patientIdinteger, (int64)

Filter by patient ID

appointmentTypeIdinteger, (int64)

Filter by appointment type ID

statusstring

Filter by status (SCHEDULED, CONFIRMED, CHECKED_IN, IN_TREATMENT, CHECKED_OUT, CANCELLED, NO_SHOW)

startDatestring

Start of date range (ISO 8601)

Example:startDate=2025-01-01T00:00:00Z

endDatestring

End of date range (ISO 8601)

Example:endDate=2025-01-31T23:59:59Z

sortBystring(?i)START_TIME|CREATED_DATE

Sort by field

Default:"START_TIME"

Enum:"START_TIME""CREATED_DATE"

sortDirstring(?i)ASC|DESC

Sort direction

Default:"ASC"

Enum:"ASC""DESC"

cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20

Example:limit=20

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/appointment?practitionerId=0&patientId=0&appointmentTypeId=0&status=string&startDate=2025-01-01T00%3A00%3A00Z&endDate=2025-01-31T23%3A59%3A59Z&sortBy=START_TIME&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Appointments retrieved successfully

Bodyapplication/json

appointmentsArray of objects(AppointmentDTO)

List of appointments in this page

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

Response

{
  "appointments": [
    { … }
  ],
  "nextCursor": "string"
}