POST
/
v1
/
organizations
/
invites

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 Anthropic API you want to use.

Read more about versioning and our version history here.

Body

application/json
email
string
required

Email of the User.

role
enum<string>
required

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

Available options:
user,
developer,
billing

Response

200 - application/json
id
string
required

ID of the Invite.

type
enum<string>
default: inviterequired

Object type.

For Invites, this is always "invite".

Available options:
invite
email
string
required

Email of the User being invited.

role
enum<string>
required

Organization role of the User.

Available options:
user,
developer,
billing,
admin
invited_at
string
required

RFC 3339 datetime string indicating when the Invite was created.

expires_at
string
required

RFC 3339 datetime string indicating when the Invite expires.

status
enum<string>
required

Status of the Invite.

Available options:
accepted,
expired,
deleted,
pending