---
title: "ReportSchedules.list"
method: GET
path: "/entities/ReportSchedules"
tags: ["Report"]
---

# ReportSchedules.list

`GET /entities/ReportSchedules`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/ReportSchedules`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/ReportSchedules/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a page of ReportSchedule records, optionally filtered, sorted and limited to selected fields.

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

Page of ReportSchedule records.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` ReportSchedule[]
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `owner` string, uri, required: User who owns the schedule. The schedule sends emails on behalf of this user. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields.
    - `report` string, uri, required: Report whose delivery is scheduled. Related Report record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Report' for its fields.
    - `owner_id` string, uuid, required: Id of the owning user.
    - `report_id` string, uuid, required: Id of the scheduled report.
    - `settings` object, required: Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document. This payload conforms to the `ReportScheduleSchema` JSON Schema (see the linked schema).
    - `revision` integer: Revision when entity was lastly changed.
    - `documents` string[]: Files attached to scheduled emails sent for this report.
    - `sender_email` string: Email address used to send the scheduled report (company email when configured, otherwise the owner's personal email).
    - `report_name` string, required: Name of the scheduled report (mirror of the linked Report.name).
    - `report_owner_id` string, uuid, required: Id of the user who owns the scheduled report.
    - `report_type` 0 | 1 | 2 | 3, required: Kind of the scheduled report (e.g. TableReport, AdvancedReport, DashboardReport). Integer enum value: 0 - TableReport, 1 - DashboardReport, 2 - ForecastReport, 3 - AdvancedReport
  - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used.
    - `start_cursor` string: Cursor of the first record of the page.
    - `end_cursor` string: Cursor of the last record of the page.
    - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them.
    - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them.
  - `total` integer: Number of records that match the request, across all pages.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)