---
title: "List Team Availability"
method: GET
path: "/appointments/availability/team"
tags: ["Appointments"]
---

# List Team Availability

`GET /appointments/availability/team`

## Request

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

Every teammate's availability windows for one day.

Cursor-paged on user id rather than offset, so a team that changes between
pages does not shift rows under you. An empty `date_ranges` means that
person has not set up a schedule, not that they are fully booked.

## Query parameters

- `date` string, required: The day, `YYYY-MM-DD`.
- `viewer_tz` string: IANA timezone. INFORMATIONAL - the windows come back in UTC and the caller renders them; this shifts nothing server-side.
- `limit` integer
- `cursor` integer, nullable: `next_cursor` from the previous page.
- `search` string, nullable: Name or email substring.
- `user_ids` integer[], nullable: Only these teammates. REPEATABLE (`?user_ids=1&user_ids=2`), and it takes PRECEDENCE over `search` - sending both ignores the search.

## Headers

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

## Response `200`

Successful Response

- ApiResponseSchedulingPayload
  - `data` SchedulingPayload, required: An open envelope for a filter, a setting, an embed config or a slot grid. Open because org settings gain branding fields as the booking page does and the embed config gains styling keys as the widget does. Closing it would drop a field the app had already started returning.
  - `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)