Invites
api/admin/invites
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/invites Changed · +59 / -32 lines
### Body parameters #### Response (200) ### Path parameters #### Response (200) ### Query parameters #### Response (200) ### Path parameters #### Response (200) ## Domain types ### Body Parameters #### Response ### Path Parameters #### Response ### Query Parameters #### Response ### Path Parameters #### Response ## Domain Types
---- -title: Invites -url: https://platform.claude.com/docs/en/api/admin/invites ---- - # Invites ## Create Invite -**post** `/v1/organizations/invites` +**POST** `/v1/organizations/invites` For Claude Enterprise organizations, this endpoint's availability is in beta. On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. -### Body Parameters +### Body parameters - `email: string` Email of the User. + format: email + - `role: "billing" or "claude_code_user" or "developer" or 2 more` Role for the invited User.
RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups (beta), and requires the key to carry the `write:rbac_groups` scope. + maxItems: 100 + ### Returns -- `Invite object { id, accepted_at, email, 6 more }` +- `Invite object` - `id: string`
RFC 3339 datetime string indicating when the Invite was accepted, or null. + format: date-time + - `email: string` Email of the User being invited.
RFC 3339 datetime string indicating when the Invite expires. + format: date-time + - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. + format: date-time + - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
For Invites, this is always `"invite"`. - - `"invite"` + default: invite ### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/invites \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
}' ``` -#### Response +#### Response (200) ```json {
## Get Invite -**get** `/v1/organizations/invites/{invite_id}` +**GET** `/v1/organizations/invites/{invite_id}` For Claude Enterprise organizations, this endpoint's availability is in beta. -### Path Parameters +### Path parameters - `invite_id: string`
### Returns -- `Invite object { id, accepted_at, email, 6 more }` +- `Invite object` - `id: string`
RFC 3339 datetime string indicating when the Invite was accepted, or null. + format: date-time + - `email: string` Email of the User being invited.
RFC 3339 datetime string indicating when the Invite expires. + format: date-time + - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. + format: date-time + - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
For Invites, this is always `"invite"`. - - `"invite"` + default: invite ### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
## List Invites -**get** `/v1/organizations/invites` +**GET** `/v1/organizations/invites` For Claude Enterprise organizations, this endpoint's availability is in beta. -### Query Parameters +### Query parameters - `after_id: optional string`
Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + format: email + - `limit: optional number` Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`. + default: 20, maximum: 1000, minimum: 1 + - `roles: optional array of string` Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
RFC 3339 datetime string indicating when the Invite was accepted, or null. + format: date-time + - `email: string` Email of the User being invited.
RFC 3339 datetime string indicating when the Invite expires. + format: date-time + - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. + format: date-time + - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
For Invites, this is always `"invite"`. - - `"invite"` + default: invite - `first_id: string or null`
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/invites \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
## Delete Invite -**delete** `/v1/organizations/invites/{invite_id}` +**DELETE** `/v1/organizations/invites/{invite_id}` For Claude Enterprise organizations, this endpoint's availability is in beta. -### Path Parameters +### Path parameters - `invite_id: string`
For Invites, this is always `"invite_deleted"`. - - `"invite_deleted"` + default: invite_deleted ### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
} ``` -## Domain Types +## Domain types ### Invite -- `Invite object { id, accepted_at, email, 6 more }` +- `Invite object` - `id: string`
RFC 3339 datetime string indicating when the Invite was accepted, or null. + format: date-time + - `email: string` Email of the User being invited.
RFC 3339 datetime string indicating when the Invite expires. + format: date-time + - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. + format: date-time + - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
For Invites, this is always `"invite"`. - - `"invite"` + default: invite ### Invite Delete Response -- `InviteDeleteResponse object { id, type }` +- `InviteDeleteResponse object` - `id: string`
For Invites, this is always `"invite_deleted"`. - - `"invite_deleted"` + default: invite_deleted