Get a project assignment
Identity module
GET/project-assignments/{id}projectAssignments.get
A person on a project, with scope nodes and dates. Returns one project assignment with its `ETag`. A project assignment the caller may not see returns 404.
- Requires the capability projects.project.read.
- OAuth scopes: projects.
- 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 project 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: ProjectAssignment
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the project 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. |
| valid_from | string (date-time) | Yes | When the assignment starts. |
| valid_to | string (date-time) | null | Yes | When the assignment ends; null while open. |
| membership_id | string (uuid) | Yes | Identifier of the org membership of the person, in the project's org. |
| project_role | "Producer" | "Department Head" | "Coordinator" | "Field Supervisor" | "Field" | Yes | Project role. |
{
"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",
"valid_from": "2026-10-08T14:30:00Z",
"valid_to": "2026-10-08T14:30:00Z",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_role": "Producer"
}Code samples
curl -X GET "$XOS_BASE_URL/project-assignments/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.projectAssignments.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.project_assignments.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos project-assignments get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f