Skip to main content
POST
/
v1
/
organizations
/
invites
cURL
curl "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "user@emaildomain.com",
    "role": "user"
  }'
{
  "email": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "invited_at": "2023-11-07T05:31:56Z",
  "role": "user",
  "status": "accepted",
  "type": "invite"
}
The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

Headers

​
x-api-key
string
required

Your unique Admin API key for authentication.

This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.

​
anthropic-version
string
required

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Body

application/json
​
email
string<email>
required

Email of the User.

Example:

"user@emaildomain.com"

​
role
enum<string>
required

Role for the invited User. Cannot be "admin".

Available options:
user,
developer,
billing,
claude_code_user
Examples:

"user"

"developer"

"billing"

"claude_code_user"

Response

Successful Response

​
email
string
required

Email of the User being invited.

Example:

"user@emaildomain.com"

​
expires_at
string<date-time>
required

RFC 3339 datetime string indicating when the Invite expires.

Example:

"2024-11-20T23:58:27.427722Z"

​
id
string
required

ID of the Invite.

Example:

"invite_015gWxCN9Hfg2QhZwTK7Mdeu"

​
invited_at
string<date-time>
required

RFC 3339 datetime string indicating when the Invite was created.

Example:

"2024-10-30T23:58:27.427722Z"

​
role
enum<string>
required

Organization role of the User.

Available options:
user,
developer,
billing,
admin,
claude_code_user
Examples:

"user"

"developer"

"billing"

"admin"

"claude_code_user"

​
status
enum<string>
required

Status of the Invite.

Available options:
accepted,
expired,
deleted,
pending
Example:

"pending"

​
type
enum<string>
default:invite
required

Object type.

For Invites, this is always "invite".

Available options:
invite
Allowed value: "invite"