---
title: "List Calendars"
method: GET
path: "/setup/v1/calendars"
tags: ["Calendars"]
---

# List Calendars

`GET /setup/v1/calendars`

Use this endpoint to return a **List of Calendars** from the requested location. If not specified, the business location defaults to the primary business location.

## Query parameters

- `locationId` string
- `deleted` boolean
- `offset` integer
- `limit` integer

## Response `200`

Success

- ScheduleListViewModel
  - `object` string, nullable
  - `url` string, nullable
  - `hasMore` boolean
  - `count` integer
  - `total` integer
  - `data` ScheduleViewModel[], nullable
    - `object` string, nullable
    - `id` string, nullable
    - `locationId` string, nullable
    - `name` string, nullable
    - `type` string, nullable
    - `primary` boolean
    - `interval` integer
    - `bookingsPerSlot` integer
    - `resourceGroupId` string, nullable
    - `deletedStatus` boolean
    - `deletedTime` string, date-time, nullable
    - `availability` CalendarHoursViewModel
      - `mon` CalendarHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `tue` CalendarHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `wed` CalendarHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `thu` CalendarHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `fri` CalendarHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `sat` CalendarHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `sun` CalendarHourViewModel
        - `startTime` integer
        - `endTime` integer

---

[API](https://skmtc.net/onsched/apis/onsched-setup-api.md) · [All operations](https://skmtc.net/onsched/apis/onsched-setup-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onsched/onsched-setup-api/revisions/c5c023458a2f/schema)