---
title: "Get schedules"
method: GET
path: "/datainsights/v1.1/schedules"
tags: ["Schedules"]
---

# Get schedules

`GET /datainsights/v1.1/schedules`

## Request

- The document declares no server URL.
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY`

## Query parameters

- `offset` integer
- `limit` integer
- `id` integer
- `subject` string
- `frequency` string
- `match` string
- `sort` 'subject,asc' | 'subject,desc' | 'view,asc' | 'view,desc' | 'format,asc' | 'format,desc' | 'created_at,asc' | 'created_at,desc' | 'updated_at,asc' | 'updated_at,desc' | 'id,asc' | 'id,desc'

## Headers

- `X-PROPERTY-ID` integer

## Response `200`

OK

- Schedules
  - `offset` integer: The difference between start of the data and the start of the response data
  - `limit` integer: The maximum number of results in the response
  - `total` integer: The total number of records
  - `schedules` SchedulePreview[]
    - `id` integer: Schedule ID
    - `frequency` string, required: Schedule frequency in [cron format](https://en.wikipedia.org/wiki/Cron). Needs to match the following pattern: ``` (0)\ # minutes ~ 0 (\*|([0-9]|1[0-9]|2[0-3])|\*)\ # hours ~ * OR 0-23 (\*|([1-9]|[1-2][0-9]?|3[0-1]))?(,(\*|([1-9]|[1-2][0-9]?|3[0-1]))){0,30}\ # day of month ~ * OR 1-31 (\*|([1-9]|1[0-2]?))?(,(\*|([1-9]|1[0-2]?))){0,12}\ # month ~ * OR 1-12 (\*|[0-6])(,(\*|[0-6])){0,7} # day of week ~ * OR 0-6 $ # matches the end of the string ``` * __0 10 * * 0,1,2,4,5__ - At 10:00 on Sunday, Monday, Tuesday, Thursday, and Friday * __0 10 * * 2__ - At 10:00 on Tuesday * __0 23 * 12 *__ - At 23:00 in December * __0 23 1,31 1,2,5,6,7,10,11 1,3__ - At 08:00 on day-of-month 1 and 31 and on Monday and Wednesday in January, February, May, June, July, October, and November
    - `view` 'formatted' | 'details': Scheduled report view. Should be either 'formatted' or 'details'
    - `format` 'xlsx' | 'csv' | 'json': Scheduled report format. Should be either 'xlsx', 'csv' or 'json'
    - `subject` string: Subject of the email
    - `recipients` string[], required: List of emails that will receive the report
    - `created_at` string: Schedule created at
    - `updated_at` string: Schedule updated at
    - `upcoming_at` string, %Y-%m-%dT%H:00:00Z: Schedule upcoming at
    - `report_ids` integer[], required: Report schedule ids
    - `property_id` integer: Property ID
    - `user_id` integer: User ID
    - `settings` ScheduleSettings
      - `require_login` boolean: Require login to view the file

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/cloudbeds/apis/data-insights-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/data-insights-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/data-insights-api/revisions/0a16807149c2?raw)