Get a record replan
Work module
GET/record-replans/{id}recordReplans.get
An append-only replan entry, logged from Scheduled onward for every date or state change. Returns one record replan with its `ETag`. A record replan 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 replan. |
| 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: RecordReplan
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the record replan. |
| 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 record. |
| reason | string | null | Yes | Replan reason.Constraints: length 1 to 20000 |
| replanned_at | string (date-time) | Yes | When the replan was logged. |
| from_state | string | Yes | Record state before the change. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| to_state | string | Yes | Record state after the change. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| old_starts_at | string (date-time) | null | Yes | Start before the change. |
| new_starts_at | string (date-time) | null | Yes | Start after the change. |
| old_ends_at | string (date-time) | null | Yes | End before the change. |
| new_ends_at | string (date-time) | null | Yes | End after the change. |
| old_due_at | string (date-time) | null | Yes | Due time before the change. |
| new_due_at | string (date-time) | null | Yes | Due time after the change. |
{
"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",
"reason": "Moved to the second weekend.",
"replanned_at": "2026-10-08T14:30:00Z",
"from_state": "Scheduled",
"to_state": "Deferred",
"old_starts_at": "2026-10-08T14:30:00Z",
"new_starts_at": "2026-10-08T14:30:00Z",
"old_ends_at": "2026-10-08T14:30:00Z",
"new_ends_at": "2026-10-08T14:30:00Z",
"old_due_at": "2026-10-08T14:30:00Z",
"new_due_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/record-replans/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.recordReplans.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.record_replans.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos record-replans get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f