Appointments

Fetch all appointments

Returns a paginated list of appointments for the business. Results can be filtered by date range, staff member, brand, cancellation status, and text search.

Set staff_id to my to return only appointments assigned to the authenticated user.

The response includes meta.total_count and meta.per_page for pagination.

Required permission: assigned_appointment_read or unassigned_appointment_read

get/api/v1/appointments

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/appointments
  • Auth: none declared. Required headers: Api-Key

Query parameters

start_datestring

Filter by start date (YYYY-MM-DD)

end_datestring

Filter by end date (YYYY-MM-DD)

staff_idstring

Filter by staff member ID, or 'my' for the authenticated user

brand_idinteger

Filter by brand ID

canceled_statusstring

Filter by cancellation status

past_or_futurestring

Filter to past or future appointments

search_textstring

Full-text search across appointment details

pageinteger

Page number for pagination (default: 1)

perinteger

Number of results per page (default: 25)

Headers

Api-Keystring required

Your Integration Key

Response

appointments found

Changes

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