title: Get Invite url: https://platform.claude.com/docs/en/api/beta/organization/invites/retrieve
Get Invite
GET /v1/organizations/invites/{invite_id}
Retrieve an invite by ID.
Path parameters
-
invite_id: stringID of the Invite.
Returns
-
BetaOrganizationInvite object-
type: "invite"Object type.
For Invites, this is always
"invite".default: invite
-
id: stringID of the Invite.
-
accepted_at: string or nullRFC 3339 datetime string indicating when the Invite was accepted, or null.
format: date-time
-
email: stringEmail of the User being invited.
-
expires_at: stringRFC 3339 datetime string indicating when the Invite expires.
format: date-time
-
invited_at: stringRFC 3339 datetime string indicating when the Invite was created.
format: date-time
-
rbac_group_ids: array of stringRBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted.
[]when none. -
role: BetaOrganizationRoleOrganization role of the User.
-
"admin" -
"billing" -
"claude_code_user" -
"developer" -
"managed" -
"membership_admin" -
"owner" -
"primary_owner" -
"user"
-
-
status: "accepted" or "deleted" or "expired" or "pending"Status of the Invite.
-
"accepted" -
"deleted" -
"expired" -
"pending"
-
-
Example
curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"Response (200)
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
"rbac_group_ids": [
"string"
],
"role": "admin",
"status": "pending",
"type": "invite"
}