Get an invite
Identity module
GET/invites/{id}invites.get
An email invitation to join an org. Created through `invites.create` (the `app.invite_member` RPC); the token is never stored or returned again. Returns one invite with its `ETag`. A invite the caller may not see returns 404.
- Requires the capability org.members.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 invite. |
| 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: Invite
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the invite. |
| 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. |
| string (email) | Yes | Invitee email. | |
| role_id | string (uuid) | Yes | Identifier of the role offered. |
| expires_at | string (date-time) | Yes | When the invite expires. |
| invited_by | string (uuid) | Yes | Identifier of the inviting person. |
| accepted_at | string (date-time) | null | Yes | When it was accepted. |
| revoked_at | string (date-time) | null | Yes | When it was revoked or replaced. |
| partner_bootstrap | boolean | Yes | True for the first Owner invite a partner issues when it creates a client org (Section 4.6.1). |
| accepted_person_id | string (uuid) | null | Yes | Identifier of the person who accepted. |
{
"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",
"email": "alex.rivera@northwindlive.example",
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"expires_at": "2026-10-08T14:30:00Z",
"invited_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"accepted_at": "2026-10-08T14:30:00Z",
"revoked_at": "2026-10-08T14:30:00Z",
"partner_bootstrap": false,
"accepted_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/invites/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.invites.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.invites.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos invites get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f