Get a role assignment
People module
GET/role-assignments/{id}roleAssignments.get
A canon workforce role staffed on a project, with its staffing ratio basis. Returns one role assignment with its `ETag`. A role assignment the caller may not see returns 404.
- Requires the capability people.directory.read.
- OAuth scopes: people.
- 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 role assignment. |
| 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: RoleAssignment
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the role assignment. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| role_code | RoleCode | Yes | Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| scope_node_id | string (uuid) | null | Yes | Identifier of the scope node. |
| person_id | string (uuid) | Yes | Identifier of the assigned person. |
| requisition_id | string (uuid) | null | Yes | Identifier of the requisition the assignment fills. |
| staffing_basis | "Declared" | "Ratio" | "Fixed" | Yes | How the role was sized: from the canon staffing ratio, a fixed canon count per tier, or declared. |
| starts_on | string (date) | null | Yes | First day of the assignment. |
| ends_on | string (date) | null | Yes | Last day of the assignment. |
| assignment_state | "Proposed" | "Active" | "Complete" | "Canceled" | Yes | Assignment state. |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_code": "5000.50.01",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"staffing_basis": "Declared",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"assignment_state": "Proposed"
}Code samples
curl -X GET "$XOS_BASE_URL/role-assignments/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.roleAssignments.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.role_assignments.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos role-assignments get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f