Get a project share
Settings module
GET/project-shares/{id}projectShares.get
A project shared with a partner org, mapping its roles onto project roles. Returns one project share with its `ETag`. A project share 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 share. |
| 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: ProjectShare
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the project share. |
| 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. |
| partner_organization_id | string (uuid) | Yes | Identifier of the partner organization. |
| valid_to | string (date-time) | null | Yes | End of the share. |
| project_role | ProjectRole | Yes | Project role (Section 8).Constraints: one of "Producer", "Department Head", "Coordinator", "Field Supervisor", "Field" |
| scope_node_ids | array of string (uuid) | Yes | Scope nodes the share opens, with everything under them; empty shares the whole scope tree. |
| valid_from | string (date-time) | Yes | When the share started. |
{
"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",
"partner_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_to": "2026-10-08T14:30:00Z",
"project_role": "Producer",
"scope_node_ids": [
"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
],
"valid_from": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/project-shares/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.projectShares.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.project_shares.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos project-shares get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f