---
title: "List Calendar Events"
method: GET
path: "/appointments/calendars/events"
tags: ["Appointments"]
---

# List Calendar Events

`GET /appointments/calendars/events`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/appointments/calendars/events`
- Auth: HTTP bearer

What is already on the connected Google / Outlook calendars in a window.

This is what makes a slot unavailable, so it is the read to reach for when
availability looks wrong. READ-ONLY and display-only: private events come
back as "Busy" blocks, and a calendar that fails to load is reported in
`errors` rather than failing the request.

## Query parameters

- `start` string, date-time, required: Window start, ISO-8601.
- `end` string, date-time, required: Window end, ISO-8601.
- `scope` 'my' | 'org': `my` for the key owner alone, `org` for every member who has not opted out. An empty `org` result means nobody shares a calendar, not that nobody is busy.
- `host_emails` string, nullable: CSV. Narrows `org` scope to these members.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseSchedulingListPayload
  - `data` SchedulingListPayload, required: An open envelope for a LIST result, so a bare list keeps its shape. A named list (`{"events": [...]}`) keeps its own key AND gains `items`, so a generic client can page any of these the same way.
    - `items` unknown[]
      - unknown
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)