Get an organization relationship
Identity module
GET/organization-relationships/{id}organizationRelationships.get
One organization's relationship to another, with the org-owned facts. Never visible to another org. Returns one organization relationship with its `ETag`. A organization relationship the caller may not see returns 404.
- Requires the capability vendors.vendor.read.
- OAuth scopes: vendors.
- 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 relationship. |
| 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: OrganizationRelationship
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the organization relationship. |
| 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. |
| organization_id | string (uuid) | Yes | Identifier of the related organization. |
| counterparty_type | CounterpartyType | null | Yes |
{
"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",
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"counterparty_type": "AV Integrator"
}Code samples
curl -X GET "$XOS_BASE_URL/organization-relationships/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.organizationRelationships.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.organization_relationships.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos organization-relationships get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f