Claude Platform Docs

Get Invite

$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}

Retrieve an invite by ID.

Parameters
--invite-id: string

ID of the Invite.

Returns
beta_organization_invite: object{ id, accepted_at, email, 6 more }
id: string

ID of the Invite.

accepted_at: string

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

formatdate-time
email: string

Email of the User being invited.

expires_at: string

RFC 3339 datetime string indicating when the Invite expires.

formatdate-time
invited_at: string

RFC 3339 datetime string indicating when the Invite was created.

formatdate-time
rbac_group_ids: array of string

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" or "billing" or "claude_code_user" or 6 more

Organization role of the User.

One of the following:
"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.

One of the following:
"accepted"
"deleted"
"expired"
"pending"
type: "invite"

Object type.

For Invites, this is always "invite".

Get Invite

ant beta:organization:invites retrieve \
  --api-key my-anthropic-api-key \
  --invite-id invite_id
{
  "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"
}
Returns Examples
{
  "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"
}