title: List Invites url: https://platform.claude.com/docs/en/api/beta/organization/invites/list
List Invites
GET /v1/organizations/invites
List the organization's invites.
Query parameters
-
after_id: optional stringID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
-
before_id: optional stringID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
-
email: optional stringFilter by the email address the Invite was sent to. Matches the same way as the Users list's
emailfilter (normalized, case-insensitive).format: email
-
limit: optional numberNumber of items to return per page.
Defaults to
20. Ranges from1to1000.default: 20, maximum: 1000, minimum: 1
-
roles: optional array of stringFilter to items whose
roleequals one of the supplied values. Repeatable; values are OR'ed together.Accepted values depend on the organization type: Console and API organizations accept
user,developer,billing,admin, andclaude_code_user; Claude Enterprise organizations acceptuser,owner,primary_owner,membership_admin, andmanaged. -
statuses: optional array of "accepted" or "expired" or "pending"Filter by Invite status. Repeatable; values are OR'ed together. Omit to return
pending,accepted, andexpiredInvites alike.-
"accepted" -
"expired" -
"pending"
-
Returns
-
data: array of BetaOrganizationInvite-
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"
-
-
-
first_id: string or nullFirst ID in the
datalist. Can be used as thebefore_idfor the previous page. -
has_more: booleanIndicates if there are more results in the requested page direction.
-
last_id: string or nullLast ID in the
datalist. Can be used as theafter_idfor the next page.
Example
curl https://api.anthropic.com/v1/organizations/invites \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"Response (200)
{
"data": [
{
"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"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}