Get a payroll run
Crew module
GET/payroll-runs/{id}payrollRuns.get
A payroll run. It cannot jump from Draft to Accepted. Returns one payroll run with its `ETag`. A payroll run 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 payroll run. |
| 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: PayrollRun
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the payroll run. |
| 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. |
| pay_period_id | string (uuid) | Yes | Identifier of the pay period. |
| payroll_run_state | "Draft" | "Calculated" | "Approved" | "Exported" | "Accepted" | "Canceled" | Yes | Payroll run state. |
| currency_code | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
{
"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",
"pay_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"payroll_run_state": "Draft",
"currency_code": "USD"
}Code samples
curl -X GET "$XOS_BASE_URL/payroll-runs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.payrollRuns.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.payroll_runs.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos payroll-runs get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f