Create a project share
Settings module
POST/project-sharesprojectShares.create
A project shared with a partner org, mapping its roles onto project roles. Creates a project share. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability org.access_grants.manage.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: ProjectShareCreate
| Field | Type | Required | Description |
|---|---|---|---|
| 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 | No | End of the share. |
| project_role | ProjectRole | No | Project role (Section 8).Constraints: one of "Producer", "Department Head", "Coordinator", "Field Supervisor", "Field" |
| scope_node_ids | array of string (uuid) | No | Scope nodes the share opens, with everything under them; empty shares the whole scope tree. |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"partner_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_to": "2026-10-08T14:30:00Z"
}Response 201: 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 POST "$XOS_BASE_URL/project-shares" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","partner_organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","valid_to":"2026-10-08T14:30:00Z"}'const { data } = await xos.projectShares.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"partner_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_to": "2026-10-08T14:30:00Z"
});response = xos.project_shares.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "partner_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "valid_to": "2026-10-08T14:30:00Z"})xos project-shares create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","partner_organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","valid_to":"2026-10-08T14:30:00Z"}'