Get a report schedule
Reports module
GET/report-schedules/{id}reportSchedules.get
A scheduled email delivery of a report to org members only. Returns one report schedule with its `ETag`. A report schedule 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 schedule. |
| 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: ReportSchedule
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the report schedule. |
| 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. |
| report_definition_id | string (uuid) | Yes | Identifier of the report definition. |
| time_zone | string | Yes | IANA time zone the local time was entered in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| cadence | "Daily" | "Weekly" | "Monthly" | Yes | How often the report is sent. |
| local_hour | integer | Yes | Local hour of delivery, 0 to 23.Constraints: range 0 to any |
| weekday | integer | null | Yes | ISO weekday (1 Monday) of a weekly delivery.Constraints: range 1 to any |
| month_day | integer | null | Yes | Day of the month (1 to 28) of a monthly delivery.Constraints: range 1 to any |
| export_format | "CSV" | "XLSX" | "PDF" | Yes | File format attached: CSV, XLSX or PDF. |
| next_run_at | string (date-time) | Yes | Next delivery time, kept by the database. |
| paused_at | string (date-time) | null | Yes | When the schedule was paused; null while it runs. |
{
"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",
"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"time_zone": "America/New_York",
"cadence": "Daily",
"local_hour": 8,
"weekday": 1,
"month_day": 1,
"export_format": "CSV",
"next_run_at": "2026-10-08T14:30:00Z",
"paused_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/report-schedules/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.reportSchedules.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.report_schedules.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos report-schedules get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f