Get a report definition
Reports module
GET/report-definitions/{id}reportDefinitions.get
A report definition with NULL-aware aggregates. Reports respect RLS and masking. Returns one report definition with its `ETag`. A report definition the caller may not see returns 404.
- Requires the capability reports.report.read.
- OAuth scopes: reports.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the report definition. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: ReportDefinition
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the report definition. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Report name.Constraints: length 1 to 300 |
| source_code | string | Yes | Source.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| chart | "Table" | "Bar" | "Line" | "Area" | "Pie" | "Number" | Yes | Chart type. |
| group_by_field | string | null | Yes | Field the rows are grouped by.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| shared | boolean | Yes | Whether everyone who may read the source sees it. |
| custom_object_type_id | string (uuid) | null | Yes | Identifier of the custom object type, when the source is custom_object. |
| membership_id | string (uuid) | Yes | Identifier of the membership that owns the report. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Labor by Department",
"source_code": "crew",
"chart": "Table",
"group_by_field": "dept_code",
"shared": false,
"custom_object_type_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/report-definitions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.reportDefinitions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.report_definitions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos report-definitions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f