List Invites
get /v1/organizations/invites
List 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.
-
limit: optional numberNumber of items to return per page.
Defaults to
20. Ranges from1to1000.
Returns
-
data: array of Invite-
id: stringID of the Invite.
-
email: stringEmail of the User being invited.
-
expires_at: stringRFC 3339 datetime string indicating when the Invite expires.
-
invited_at: stringRFC 3339 datetime string indicating when the Invite was created.
-
role: "user" or "developer" or "billing" or 2 moreOrganization role of the User.
-
"user" -
"developer" -
"billing" -
"admin" -
"claude_code_user"
-
-
status: "accepted" or "expired" or "deleted" or "pending"Status of the Invite.
-
"accepted" -
"expired" -
"deleted" -
"pending"
-
-
type: "invite"Object type.
For Invites, this is always
"invite"."invite"
-
-
first_id: stringFirst 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: stringLast 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_ADMIN_API_KEY"
Response
{
"data": [
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
"role": "user",
"status": "pending",
"type": "invite"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}