# Read a report

Returns a single report's definition and current generation state. status moves
through queued, processing and then completed or failed, and last_generated_at
and file_path are only populated once a run has finished - use the download
endpoint to obtain a link rather than reading file_path directly.

Endpoint: GET /api/v2/report/{id}
Version: 2.0.0
Security: default

## Path parameters:

  - `id` (integer, required)
    The ID of the report.

## Header parameters:

  - `Rosterfy-Platform` (string)

## Response 200 fields (application/json):

  - `object` (object)

  - `object.id` (integer)

  - `object.report_type_id` (integer)

  - `object.report_category_id` (string | null)

  - `object.user_id` (integer)

  - `object.name` (string)

  - `object.filters` (array)

  - `object.columns` (array)

  - `object.columns.name` (string)

  - `object.columns.label` (string)

  - `object.columns.value` (string)

  - `object.sorting` (array)

  - `object.grouping` (array)

  - `object.with_media` (integer)

  - `object.with_subaccounts` (integer)

  - `object.file_path` (string | null)

  - `object.file_type` (string)

  - `object.status` (string)

  - `object.error_message` (string | null)

  - `object.is_scheduled` (integer)

  - `object.start_date` (string | null)

  - `object.start_time` (string | null)

  - `object.end_date` (string | null)

  - `object.timezone` (string | null)

  - `object.repeat` (string | null)

  - `object.meta` (array)

  - `object.last_generated_at` (string | null)

  - `object.destination_meta` (string | null)

  - `object.deleted_at` (string | null)

  - `object.created_at` (string)

  - `object.updated_at` (string)

  - `nice` (object)

  - `nice.rrn` (string)

  - `nice.status` (string)

  - `nice.columns_preview` (string)

  - `relations` (object)

  - `relations.report_type` (object)

  - `relations.report_type.object` (object)

  - `relations.report_type.object.id` (integer)

  - `relations.report_type.object.type` (string)

  - `relations.report_type.object.name` (string)

  - `relations.report_type.object.entities` (array)

  - `relations.report_type.object.only_trashed` (integer)

  - `relations.report_type.object.filters` (string | null)

  - `relations.report_type.object.deleted_at` (string | null)

  - `relations.report_type.object.created_at` (string)

  - `relations.report_type.object.updated_at` (string)

  - `relations.report_type.nice` (array)

  - `relations.report_type.permissions` (object)

  - `relations.report_type.permissions.read` (boolean)

  - `relations.report_type.permissions.update` (boolean)

  - `relations.report_type.permissions.delete` (boolean)

  - `permissions` (object)

  - `permissions.read` (boolean)

  - `permissions.update` (boolean)

  - `permissions.delete` (boolean)

  - `permissions.share` (boolean)