Get a pay period
Crew module
GET/pay-periods/{id}payPeriods.get
A pay period. A posted pay period cannot reopen. Returns one pay period with its `ETag`. A pay period the caller may not see returns 404.
- Requires the capability crew.schedule.read.
- OAuth scopes: crew.
- 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 pay period. |
| 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: PayPeriod
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the pay period. |
| 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. |
| starts_on | string (date) | Yes | First day. |
| ends_on | string (date) | Yes | Last day. |
| pay_period_state | string | Yes | Pay period state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
{
"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",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"pay_period_state": "Open"
}Code samples
curl -X GET "$XOS_BASE_URL/pay-periods/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.payPeriods.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.pay_periods.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos pay-periods get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f