# List calendar zones

Returns a paginated list of calendar zones for the practice identified by
`X-Practice-Id`. A calendar zone is one occurrence of a scheduled, recurring
block of diary time reserved for a specific purpose, for a practitioner or a
room.
**Required query parameters:** `date_from` and `date_to` (inclusive,
`YYYY-MM-DD`). Calendar zones that overlap the window are returned: a
calendar zone is included when it starts on or before the end of `date_to`
and finishes on or after the start of `date_from`. Past and future dates
are accepted. `date_to` must be on or after `date_from`, and the window must
not exceed **90 days**; otherwise the API responds with **422**.
When `practitioner_id` is supplied, only calendar zones scheduled for that
practitioner are returned. A `practitioner_id` that is not a valid UUID
results in **422**.
Results are ordered by start time and ID, earliest first (`start_time`
ascending, then `id` ascending). Use `limit` and the `meta.cursor` value
from the response to retrieve further pages.
**Note:** calendar zones were known as session appointments
(`session_appointments`) in the previous API version.

Endpoint: GET /calendar_zones
Version: 2026-01-01
Security: oauth2

## Security:

  - `oauth2` (unknown)
    oauth2 scopes: calendar:read

## Query parameters:

  - `limit` (integer)
    Maximum number of records to return per page.

  - `cursor` (string)
    Cursor reference to the next page of records.

  - `date_from` (string, required)
    Inclusive start of a required date range filter (`YYYY-MM-DD`). Pair with
`date_to`. Specific range limits and matching rules are defined per
endpoint.

  - `date_to` (string, required)
    Inclusive end of a required date range filter (`YYYY-MM-DD`). Pair with
`date_from`. Specific range limits and matching rules are defined per
endpoint.

  - `practitioner_id` (string)
    Filter records to those associated with the specified practitioner. The value should be a UUID corresponding to a practitioner within the practice.

  - `created_date_from` (string)
    Inclusive start of a created date range filter. Calendar date only (`YYYY-MM-DD`).
Use together with `created_date_to` for explicit date range control.
- When used together with `created_date_to`, the range between the two values must not exceed 90 days.
- When used without `created_date_to`, returns records from `created_date_from` up to 90 days later
(or up to the current date-time if it is earlier).

  - `created_date_to` (string)
    Inclusive end of a created date range filter. Calendar date only (`YYYY-MM-DD`).
Use together with `created_date_from` for explicit date range control.
- When used together with `created_date_from`, the range between the two values must not exceed 90 days.
- When used without `created_date_from`, returns records from 90 days before `created_date_to` (or from the
earliest available date if less than 90 days of data exists) up to `created_date_to`.

  - `updated_date_from` (string)
    Inclusive start of an updated date range filter. Calendar date only (`YYYY-MM-DD`).
Use together with `updated_date_to` for explicit date range control.
- When used together with `updated_date_to`, the range between the two values must not exceed 90 days.
- When used without `updated_date_to`, returns records from `updated_date_from` up to 90 days later
(or up to the current date-time if it is earlier).

  - `updated_date_to` (string)
    Inclusive end of an updated date range filter. Calendar date only (`YYYY-MM-DD`).
Use together with `updated_date_from` for explicit date range control.
- When used together with `updated_date_from`, the range between the two values must not exceed 90 days.
- When used without `updated_date_from`, returns records from 90 days before `updated_date_to` (or from the
earliest available date if less than 90 days of data exists) up to `updated_date_to`.

## Header parameters:

  - `X-Practice-Id` (string, required)
    UUID of the **practice** in whose context the request is executed. The API
uses this to resolve data the caller is permitted to access for that practice.

## Response 200:

  - `200` (unknown)
    Paginated list of calendar zones for the requested practice.

## Response 200 fields (application/json):

  - `data` (array, required)
    Calendar zones in the current page.

  - `data.id` (string, required)
    Unique identifier for the calendar zone.
    Example: 9b2f4c1e-3d5a-4e8b-a7c6-1f2e3d4c5b6a

  - `data.title` (string, required)
    Title of the calendar zone, as shown in the practice diary.
    Example: Emergency slots

  - `data.start_time` (string, required)
    Start time of the calendar zone in ISO 8601 format in UTC.
    Example: 2026-01-05T09:00:00Z

  - `data.finish_time` (string, required)
    Finish time of the calendar zone in ISO 8601 format in UTC.
    Example: 2026-01-05T12:00:00Z

  - `data.practitioner` (object, required)
    The practitioner the calendar zone is scheduled for. Null when the calendar zone is scheduled for a room instead. Retrieve the full practitioner record for additional details.

  - `data.practitioner.id` (string, required)
    Unique identifier of the practitioner.
    Example: 550e8400-e29b-41d4-a716-446655440003

  - `data.practitioner.name` (string)
    Full display name of the practitioner.
    Example: Dr. John Smith

  - `data.room_id` (string, required)
    Identifier of the room the calendar zone is scheduled for, if applicable.
    Example: 550e8400-e29b-41d4-a716-446655440004

  - `data.zone_group` (object, required)
    The zone group the calendar zone belongs to, if any. Zone groups are practice-defined labels that group related calendar zones together.

  - `data.zone_group.id` (string, required)
    Unique identifier of the zone group.
    Example: 0f8fad5b-d9cb-469f-a165-70867728950e

  - `data.zone_group.name` (string, required)
    Display name of the zone group.
    Example: New patient exams

  - `data.created_at` (string, required)
    When the calendar zone was created (UTC, ISO 8601). Null for some older calendar zones.
    Example: 2025-12-01T10:15:00Z

  - `data.updated_at` (string, required)
    When the calendar zone was last updated (UTC, ISO 8601). Null for some older calendar zones.
    Example: 2025-12-01T10:15:00Z

  - `meta` (object, required)
    Cursor-based pagination metadata. When an operation supports paging, pass `cursor` from this object on a subsequent request to continue after the current page.

  - `meta.cursor` (string, required)
    Opaque pagination cursor for the next page. Clients should treat this value as an opaque token.
    Example: eyJjdXJzb3IiOiJuZXh0In0

## Response 400:

  - `400` (unknown)
    Malformed Request ([ProblemDetails](https://tools.ietf.org/html/rfc7807))

## Response 400 fields (application/problem+json):

  - `type` (string)
    A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that
identifies the problem type. It should provide human-readable
documentation for the problem type. When this member is not present, its
value is assumed to be "about:blank".
    Example: https://httpstatuses.io/400

  - `title` (string)
    A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
    Example: Bad Request

  - `status` (integer)
    The HTTP status code.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: Missing required field 'address'

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if de-referenced.
    Example: /v2/sites

## Response 401:

  - `401` (unknown)
    Unauthorized - Provide proof of identity ([ProblemDetails](https://tools.ietf.org/html/rfc7807))

## Response 401 fields (application/problem+json):

  - `type` (string)
    A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that
identifies the problem type. It should provide human-readable
documentation for the problem type. When this member is not present, its
value is assumed to be "about:blank".
    Example: https://httpstatuses.io/400

  - `title` (string)
    A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
    Example: Bad Request

  - `status` (integer)
    The HTTP status code.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: Missing required field 'address'

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if de-referenced.
    Example: /v2/sites

## Response 422:

  - `422` (unknown)
    Validation Error ([ProblemDetails](https://tools.ietf.org/html/rfc7807))

## Response 422 fields (application/problem+json):

  - `type` (string)
    A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that
identifies the problem type. It should provide human-readable
documentation for the problem type. When this member is not present, its
value is assumed to be "about:blank".
    Example: https://httpstatuses.io/400

  - `title` (string)
    A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
    Example: Bad Request

  - `status` (integer)
    The HTTP status code.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: Missing required field 'address'

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if de-referenced.
    Example: /v2/sites

## Response 4XX:

  - `4XX` (unknown)
    User Error ([ProblemDetails](https://tools.ietf.org/html/rfc7807))

## Response 4XX fields (application/problem+json):

  - `type` (string)
    A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that
identifies the problem type. It should provide human-readable
documentation for the problem type. When this member is not present, its
value is assumed to be "about:blank".
    Example: https://httpstatuses.io/400

  - `title` (string)
    A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
    Example: Bad Request

  - `status` (integer)
    The HTTP status code.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: Missing required field 'address'

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if de-referenced.
    Example: /v2/sites

## Response 5XX:

  - `5XX` (unknown)
    Server Error ([ProblemDetails](https://tools.ietf.org/html/rfc7807))

## Response 5XX fields (application/problem+json):

  - `type` (string)
    A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that
identifies the problem type. It should provide human-readable
documentation for the problem type. When this member is not present, its
value is assumed to be "about:blank".
    Example: https://httpstatuses.io/400

  - `title` (string)
    A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
    Example: Bad Request

  - `status` (integer)
    The HTTP status code.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: Missing required field 'address'

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if de-referenced.
    Example: /v2/sites

## Response 200 examples:

  - `First page of calendar zones` (unknown)
    Paginated list with a cursor for the next page.

## Response 400 examples:

  - `Malformed or invalid request` (unknown)
    RFC 7807 problem details when validation fails (e.g. missing required field).

## Response 401 examples:

  - `Missing or invalid credentials` (unknown)
    RFC 7807 problem details when the caller is not authenticated.

## Response 422 examples:

  - `Validation error` (unknown)
    RFC 7807 problem details when the request is well-formed but fails business validation.

## Response 4XX examples:

  - `Generic client error response` (unknown)
    RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).

## Response 5XX examples:

  - `Unexpected server error` (unknown)
    RFC 7807 problem details for an internal failure.