---
title: "ReportSchedules.get"
method: GET
path: "/entities/ReportSchedules/{id}"
tags: ["Report"]
---

# ReportSchedules.get

`GET /entities/ReportSchedules/{id}`

Returns ReportSchedule with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

ReportSchedule data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` ReportSchedule
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `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. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `report` string, uri, required — Report whose delivery is scheduled. Relation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties.
    - `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.
    - `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

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

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