Get Invite
api/admin/invites/retrieve
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/invites/retrieve Changed · +15 / -14 lines
# Get Invite ## Path parameters ## Returns ## Example ### Response (200) ## Get Invite ### Path Parameters ### Returns ### Example #### Response
---- -title: Get Invite -url: https://platform.claude.com/docs/en/api/admin/invites/retrieve ---- +# Get Invite -## Get Invite +**GET** `/v1/organizations/invites/{invite_id}` -**get** `/v1/organizations/invites/{invite_id}` - For Claude Enterprise organizations, this endpoint's availability is in beta. -### Path Parameters +## Path parameters - `invite_id: string` ID of the Invite. -### Returns +## Returns -- `Invite object { id, accepted_at, email, 6 more }` +- `Invite object` - `id: string`
RFC 3339 datetime string indicating when the Invite was accepted, or null. + format: date-time + - `email: string` Email of the User being invited.
RFC 3339 datetime string indicating when the Invite expires. + format: date-time + - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. + format: date-time + - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
For Invites, this is always `"invite"`. - - `"invite"` + default: invite -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +### Response (200) ```json {