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

# Reports.get

`GET /entities/Reports/{id}`

Returns Report with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

Report data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Report
    - `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 report or dashboard. 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.
    - `reports_folder` string, uri, required — Report folder this report is filed under (default folder when empty). Relation to ReportFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportFolder' object for properties.
    - `sync_entity` string, uri — Specific record this report is synchronized to. Set only when sync_enabled is true. Relation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties.
    - `access_link` string — Public access token used in shareable report URLs. Empty when public sharing is not configured for the report.
    - `ai_conversation` object — AI assistant conversation associated with the report (e.g. records of AI-driven report generation).
    - `description` string — Free-text description shown alongside the report.
    - `name` string, required — Name of the entity and its default text representation.
    - `owner_id` string, uuid, required — Id of the owning user.
    - `reports_folder_id` string, uuid, required — Id of the parent report folder.
    - `settings` object, required — Report definition (entity, columns, filters, charts, structure). Stored as a JSON document.
    - `share_mode` 0 | 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
    - `share_mode_params` string — Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users).
    - `sync_enabled` boolean — When true, name and settings are kept in sync with the linked screen profile; when false, the report is detached from profile sync.
    - `sync_entity_id` string, uuid — Id of the synchronized record.
    - `type` 0 | 1 | 2 | 3, required — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - TableReport, 1 - DashboardReport, 2 - ForecastReport, 3 - AdvancedReport
    - `revision` integer — Revision when entity was lastly changed.
    - `schedule` string, uri — Scheduled-delivery configuration for this report. Empty when no schedule is set; modified via set_schedule / remove_schedule mutations. Relation to ReportSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSchedule' object for properties.
    - `is_favorite` boolean, required — True when the current user has marked this report as a favorite (see ClientFavorite).
    - `sharing_units` string[] — Sales units granted shared access to this report (custom share mode).
    - `sharing_clients` string[] — Users granted shared access to this report (custom share mode).

## 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)