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

# Reports.get

`GET /entities/Reports/{id}`

## 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/Reports/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Reports/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the Report record with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `expand` string

## Response `200`

The Report record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` Report: Saved report or dashboard with its settings, sharing and delivery schedule.
    - `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 report or dashboard. 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.
    - `reports_folder` string, uri, required: Report folder this report is filed under (default folder when empty). Related ReportFolder record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ReportFolder' for its fields.
    - `sync_entity` string, uri: Specific record this report is synchronized to. Set only when sync_enabled is true. Related Profile record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Profile' for its fields.
    - `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. This payload conforms to the `ReportSettings` JSON Schema (see the linked schema).
    - `share_mode` 0 | 1 | 2 | 3: Who besides the owner can access the report: nobody (Private, the default), the users and sales units in sharing_clients and sharing_units (Standard), or all users (AllView to view, AllEdit to also edit). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
    - `share_mode_params` string: Legacy additional sharing options; kept with the record but no longer applied.
    - `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: Kind of report: a table or pivot report, a dashboard, an opportunity forecast, or an advanced report built from several linked tables. Integer enum value: 0 - TableReport, 1 - DashboardReport, 2 - ForecastReport, 3 - AdvancedReport
    - `revision` integer: Revision when entity was lastly changed.
    - `schedule` string, uri: The calling user's scheduled email delivery of this report; empty when none is set. Set it with `setScheduleReport` and remove it with `removeScheduleReport`. Related ReportSchedule record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ReportSchedule' for its fields.
    - `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

- `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).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `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)