Get a support session
Platform module
GET/support-sessions/{id}supportSessions.get
A support session (1060): the client org's Owner lets its partner's staff read the client org for 1 to 24 hours. Partner staff read nothing of a client without one; they never write. Created with supportSessions.grant and ended early with supportSessions.end. Returns one support session with its `ETag`. A support session 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 support session. |
| 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: SupportSession
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the support session. |
| 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. |
| 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. |
| grantee_org_id | string (uuid) | Yes | Identifier of the partner org whose staff may read while the session lasts. |
| reason | string | Yes | Why the session was granted.Constraints: length 1 to 500 |
| starts_at | string (date-time) | Yes | When access began. |
| ends_at | string (date-time) | Yes | When access ends on its own, at most 24 hours after it began. |
| ended_at | string (date-time) | null | Yes | When someone ended the session early. |
| ended_by | string (uuid) | null | Yes | Identifier of the person who ended it early. |
{
"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",
"grantee_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"reason": "Help with the venue import.",
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"ended_at": "2026-10-08T14:30:00Z",
"ended_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/support-sessions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.supportSessions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.support_sessions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos support-sessions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f