ANanthropics

Get Invite

Changed on

Retrieve an invite by ID.

get/v1/organizations/invites/{invite_id}

Request

  • Base URL
    https://api.anthropic.com
  • Auth
    none declared

Path parameters

invite_idstring required

ID of the Invite.

Headers

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Response

Successful Response

accepted_atstring date-time nullable required

RFC 3339 datetime string indicating when the Invite was accepted, or null.

emailstring required

Email of the User being invited.

expires_atstring date-time required

RFC 3339 datetime string indicating when the Invite expires.

idstring required

ID of the Invite.

invited_atstring date-time required

RFC 3339 datetime string indicating when the Invite was created.

rbac_group_idsstring[] required

RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. [] when none.

role'admin' | 'billing' | 'claude_code_user' | 'developer' | 'managed' | 'membership_admin' | 'owner' | 'primary_owner' | 'user' required
status'accepted' | 'deleted' | 'expired' | 'pending' required
type'invite' required

Object type.

For Invites, this is always "invite".

Example response

{
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "invited_at": "2024-10-30T23:58:27.427722Z"
}

Changes