Get a record recurrence
Schedule module
GET/record-recurrences/{id}recordRecurrences.get
A recurrence rule that generates records. Returns one record recurrence with its `ETag`. A record recurrence the caller may not see returns 404.
- Requires the capability work.record.read.
- OAuth scopes: work.
- 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 record recurrence. |
| 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: RecordRecurrence
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the record recurrence. |
| 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. |
| record_id | string (uuid) | Yes | Identifier of the template record. |
| rrule | string | Yes | RFC 5545 recurrence rule.Constraints: length 1 to 300 |
| time_zone | string | Yes | IANA time zone the local time was entered in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| until | string (date) | null | Yes | Last date of the series. |
{
"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",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rrule": "FREQ=WEEKLY;BYDAY=SA",
"time_zone": "America/New_York",
"until": "2026-10-08"
}Code samples
curl -X GET "$XOS_BASE_URL/record-recurrences/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.recordRecurrences.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.record_recurrences.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos record-recurrences get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f