Source: https://docs.claude.com/en/api/admin-api/invites/create-invite

Agent Skills are now available! Learn more about extending Claude's capabilities with Agent Skills .

Claude Docs home page

English

Search...

Ctrl K

Search...

Navigation

Organization Invites

Create Invite

Home Developer Guide API Reference Model Context Protocol (MCP) Resources Release Notes

cURL

cURL

Copy

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"
  }'

200

4XX

Copy

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

POST

/

v1

/

organizations

/

invites

cURL

cURL

Copy

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"
  }'

200

4XX

Copy

{
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "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.

Examples:

"user@emaildomain.com"

​

role

enum<string>

required

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

Available options:

user,

developer,

billing,

admin,

claude_code_user

Response

200

application/json

Successful Response

​

email

string

required

Email of the User being invited.

Examples:

"user@emaildomain.com"

​

expires_at

string<date-time>

required

RFC 3339 datetime string indicating when the Invite expires.

Examples:

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

​

id

string

required

ID of the Invite.

Examples:

"invite_015gWxCN9Hfg2QhZwTK7Mdeu"

​

invited_at

string<date-time>

required

RFC 3339 datetime string indicating when the Invite was created.

Examples:

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

​

role

enum<string>

required

Organization role of the User.

Available options:

user,

developer,

billing,

admin,

claude_code_user

​

status

enum<string>

required

Status of the Invite.

Available options:

accepted,

expired,

deleted,

pending

​

type

enum<string>

default:invite

required

Object type.

For Invites, this is always "invite".

Available options:

| Title | Const | | --- | --- | | Type | invite |

Was this page helpful?

YesNo

List Invites Delete Invite

Assistant

Responses are generated using AI and may contain mistakes.