Get an organization
Identity module
GET/organizations/{id}organizations.get
Every company on the platform: a tenant (with a subscription), an external account, or both. A partner org cannot have a parent partner. Returns one organization with its `ETag`. A organization the caller may not see returns 404.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- 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 organization. |
| 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: Organization
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the organization. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| name | string | Yes | Trade name.Constraints: length 1 to 300 |
| slug | string | Yes | URL slug.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| parent_org_id | string (uuid) | null | Yes | Identifier of the partner organization. |
| organization_type | string | Yes | Legal form from `xpms.organization_type` (decision D17): For-Profit, Nonprofit or Public Agency. It decides which worker classifications engagements may use.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"name": "Northwind Live",
"slug": "northwind-live",
"parent_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"organization_type": "For-Profit"
}Code samples
curl -X GET "$XOS_BASE_URL/organizations/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.organizations.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.organizations.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos organizations get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f