CAcarecycle
Appointments

List appointments

List your organization's appointments.

get/v2/appointments

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/appointments
  • Auth
    API key in header x-api-key

Query parameters

startDatestring date-time

GET /v2/appointments Parameter

endDatestring date-time

GET /v2/appointments Parameter

memberstring

Comma-separated member UUIDs. Filter to appointments assigned to any of these members.

clientCustomerIdstring uuid

GET /v2/appointments Parameter

appointmentConfigIdstring

Comma-separated appointment config UUIDs. Filter to appointments using any of these scheduling configs.

campaignIdstring

Comma-separated campaign UUIDs. Filter to appointments originating from any of these campaigns.

statusstring

Comma-separated status filter. Omit to return all statuses.

bookingSourcestring

Comma-separated booking source filter

appointmentModestring

Comma-separated appointment mode filter

sort'asc' | 'desc'

GET /v2/appointments Parameter

limitinteger

GET /v2/appointments Parameter

cursorstring

GET /v2/appointments Parameter

Response

GET /v2/appointments Positive response

totalinteger required
nextCursorstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.