---
title: "Get Calendar Appointments"
method: GET
path: "/calendars/{calendarId}/appointments"
tags: ["calendar"]
---

# Get Calendar Appointments

`GET /calendars/{calendarId}/appointments`

## Request

- Base URL: `https://api.acculynx.com/api/v2`
- URL: `https://api.acculynx.com/api/v2/calendars/{calendarId}/appointments`
- Auth: HTTP bearer

Use this endpoint to get a list of appointments for the specified calendar. The request range should not exceed 90 days.

## Path parameters

- `calendarId` string, uuid, required

## Query parameters

- `eventType` string
- `pageSize` integer
- `recordStartIndex` integer
- `startDate` string, date, required
- `endDate` string, date, required
- `jobId` string, uuid

## Response `200`

OK

- CalendarSearchEventCollection
  - `count` integer: The total number of items matching the current query.
  - `pageSize` integer: The requested or default page size.
  - `pageStartIndex` integer: The requested or default index of the first element to return.
  - `items` CalendarSearchEvent[]
    - `id` string, uuid: The unique GUID of the calendar event.
    - `eventType` 'All' | 'Personal' | 'InitialAppointment' | 'MaterialDelivery' | 'CrewLabor'
    - `title` string: The name of the calendar event.
    - `attendees` CompanyUserLink[]
      - `id` string, uuid: The unique GUID of the AccuLynx User.
      - `_link` string: The unique URI of the AccuLynx User.
    - `job` JobLink
      - `id` string, uuid: The job's unique ID.
      - `_link` string: The URI of this Job.
    - `allDay` boolean: Whether the event is an all day event.
    - `start` string, date-time: The start date/time of the event.
    - `end` string, date-time: The end date/time of the event.
    - `jobName` string: The name of the job associated with the event, if any.\
    - `location` string: The address where the appointment is to take place.
    - `sharedWithCustomerPortal` boolean: Indicates if the event is shared with the customer portal.
    - `_link` string: The URI of the this calendar event.

## Other responses

- `400`: The query parameters are invalid.
- `404`: The given calendar was not found.
- `416`: The value for the pageStartIndex query parameter is outside the range of the return values.

## Changes

- **2026-11-03** `443924b00f43`: 1 breaking
  - for the `query` request parameter `pageSize`, default value `25` was removed

[Operation history](https://skmtc.dev/acculynx/apis/acculynx-api-v2/changes/calendars/:calendarId/appointments/get.md)

---

[API](https://skmtc.dev/acculynx/apis/acculynx-api-v2.md) - [All operations](https://skmtc.dev/acculynx/apis/acculynx-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/acculynx-api-v2/revisions/443924b00f43?raw)