---
title: "List appointments"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/appointment"
tags: ["Appointment"]
---

# List appointments

`GET /api/business/{businessId}/branch/{branchId}/appointment`

Get a list of appointments for the specified business id and branch id, with a maximum one month date range. List can be filtered by date of appointment, DateTime of update, staff id, room id, machine id or client id with possibility to include canceled, deleted or archived appointments and option to fetch online categories and notes of appointments. Results can be sorted using the standard 'sort' parameter in 'property,direction' form (e.g. 'sort=appointmentDate,desc'); when omitted, results are returned in the default order - by creation date, or by update time for updated-range queries.

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Query parameters

- `from_date` string, date
- `to_date` string, date
- `staff_id` string
- `room_id` string
- `machine_id` string
- `client_id` string
- `fetch_canceled` boolean
- `fetch_deleted` boolean
- `fetch_archived` boolean
- `updated_from` string
- `updated_to` string
- `fetch_online_category` boolean
- `fetch_notes` boolean
- `group_booking_id` string

## Response `200`

Appointments listed

- DataPagedModelAppointmentResponse
  - `_embedded` object
    - `appointments` AppointmentResponse[]
      - `appointmentId` string, required
      - `version` integer, required
      - `appointmentDate` string
      - `startTime` string, required
      - `endTime` string — If the staff/service is changed then the duration is calculated from the new staff/service and endTime is ignored. Otherwise the endTime given is used.
      - `price` number
      - `staffId` string, required
      - `roomId` string
      - `machineId` string
      - `confirmed` boolean
      - `serviceId` string
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `staffRequest` boolean
      - `preferredStaff` boolean
      - `clientId` string
      - `serviceRewardId` string
      - `courseId` string
      - `courseName` string
      - `clientCourseId` string
      - `clientCourseItemId` string
      - `purchasingBranchId` string
      - `serviceGroupItemOptionId` string
      - `serviceGroupId` string
      - `parentServiceGroupId` string — This is the id of a service group at a business level and corresponds to the service group id used in the booking apis
      - `serviceName` string
      - `state` 'BOOKED' | 'CHECKED_IN' | 'PAID'
      - `activationState` 'RESERVED' | 'ACTIVE' | 'CANCELED'
      - `waitingListDateTime` string, date-time
      - `depositAmount` number
      - `depositDateTime` string, date-time
      - `bookingId` string
      - `source` string
      - `groupBookingId` string
      - `deleted` boolean
      - `notes` string
      - `internetServiceCategories` InternetServiceCategory[] — Contains list of the ID and name of an internet service category that a service belongs to. This data is available only if <code>fetch_online_category</code> parameter is set to true
        - `id` string
        - `name` string
      - `branchId` string
      - `isFinishAppointment` boolean — Indicates if this appointment is the concluding segment of a split service.
  - `page` PageMetadata
    - `size` integer
    - `totalElements` integer
    - `totalPages` integer
    - `number` integer

## Other responses

- `400` — Invalid request parameters. Returned when: neither a [from_date, to_date] range nor an [updated_from, updated_to] range is supplied; only one bound of a range is supplied (both bounds are required); a supplied date range spans more than 31 days; a from_date, to_date, updated_from or updated_to value is not a valid date/date-time; or 'sort' is not one of the supported values ('appointmentDate', 'creationDate')
- `404` — Business or branch with specified ids don't exist
- `429` — Request rate limit exceeded. Current limit set to 100 rps.
- `500` — Internal Server Error

---

[API](https://skmtc.net/phorest/apis/third-party-api.md) · [All operations](https://skmtc.net/phorest/apis/third-party-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/phorest/third-party-api/revisions/2218bc90d39c/schema)