---
title: "Get Appointments"
method: GET
path: "/appointments"
tags: ["appointments"]
---

# Get Appointments

`GET /appointments`

Retrieve all existing appointments.

## Query parameters

- `mock` boolean
- `id` string[]
- `scheduledStartDateTime` string, date-time
- `scheduledEndDateTime` string, date-time
- `actualStartDateTime` string, date-time
- `actualEndDateTime` string, date-time
- `startDateRange` string, date-time
- `endDateRange` string, date-time
- `perPage` integer
- `pageAfter` string
- `orderBy` string
- `order` 'asc' | 'desc'
- `organizationId` string, uuid
- `status` string
- `resourceUri` string, string

## Response `200`

Return an array of data responses

- object
  - `data` AppointmentDataResponse[], required — Array of data response objects
    - `type` string — Type of resource
    - `id` string, uuid — UUID of resource; additional resource attributes will also be returned
    - `attributes` object — Attributes of resource
      - `organizationAppointmentId` string — Internally identifiable organization's ID for the appointment
      - `createdAt` string, date-time — Appointment creation Date
      - `updatedAt` string, date-time — Appointment last updated Date
      - `scheduledStartDateTime` string, date-time — Scheduled appointment start dateTime
      - `scheduledEndDateTime` string, date-time — Scheduled appointment end dateTime
      - `actualStartDateTime` string, date-time — Actual appointment start dateTime
      - `actualEndDateTime` string, date-time — Actual appointment end dateTime
      - `status` 'occurred' | 'requested' | 'confirmed' | 'canceled' | 'checkedIn' | 'noShow' — Appointment status
      - `customerMessage` string — A customer message containing any comments about the appointment
      - `updatedBy` union — The UUID of the user that most recently updated the appointment
        - string, uuid
        - unknown
      - `createdBy` string, uuid — The UUID of the user that created the appointment
    - `relationships` AppointmentRelationships — Relationships of an appointment
      - `organization` OrganizationRelationship — Organization that the resource belongs to
        - `data` object
          - `type` string — Type of the organization
          - `id` string, uuid — UUID of the organization
      - `resources` object
        - `data` object[] — Types and UUIDs of the appointment resources
          - `type` 'locations' | 'users' | 'customers' | 'services' — Type of resource
          - `id` string, uuid — UUID of resource
      - `answers` object
        - `data` object[] — Customer's answers to questions associated with the appointment
          - `type` string — Type of the answer
          - `id` string, uuid — UUID of the answer
    - `links` Link — Link object for resource meta data
      - `self` string
  - `links` Pagination, required
    - `self` string, required — Link to current page of data response
    - `next` string — Link to next page of data response

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/brickworksoftware/apis/brickwork-software-api.md) · [All operations](https://skmtc.dev/brickworksoftware/apis/brickwork-software-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/brickworksoftware/brickwork-software-api/revisions/b06aa4f3b83c/schema)