--- title: Invites url: https://platform.claude.com/docs/en/api/ruby/beta/organization/invites --- # Invites ## Create Invite `beta.organization.invites.create(**kwargs) -> BetaOrganizationInvite` **POST** `/v1/organizations/invites` Invite a user to join the organization by email. 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. ### Parameters - `email: String` Email of the User. format: email - `role: :billing | :claude_code_user | :developer | 2 more` Role for the invited User. The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; inviting with the `managed` role requires the `write:rbac_groups` scope in addition to `write:members`. - `:billing` - `:claude_code_user` - `:developer` - `:managed` - `:user` - `rbac_group_ids: Array[String]` 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, and requires the key to carry the `write:rbac_groups` scope. maxItems: 100 ### Returns - `class BetaOrganizationInvite` - `type: :invite` Object type. For Invites, this is always `"invite"`. - `id: String` ID of the Invite. - `accepted_at: Time` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: String` Email of the User being invited. - `expires_at: Time` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: Time` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: Array[String]` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: BetaOrganizationRole` Organization role of the User. - `:admin` - `:billing` - `:claude_code_user` - `:developer` - `:managed` - `:membership_admin` - `:owner` - `:primary_owner` - `:user` - `status: :accepted | :deleted | :expired | :pending` Status of the Invite. - `:accepted` - `:deleted` - `:expired` - `:pending` ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") beta_organization_invite = anthropic.beta.organization.invites.create(email: "user@emaildomain.com", role: :user) puts(beta_organization_invite) ``` #### Response (200) ```json { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } ``` ## List Invites `beta.organization.invites.list(**kwargs) -> Page` **GET** `/v1/organizations/invites` List the organization's invites. ### Parameters - `after_id: String` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id: String` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `email: String` (query parameter) 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: Integer` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `roles: Array[String]` (query parameter) Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. - `statuses: Array[:accepted | :expired | :pending]` (query parameter) Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. - `:accepted` - `:expired` - `:pending` ### Returns - `class BetaOrganizationInvite` - `type: :invite` Object type. For Invites, this is always `"invite"`. - `id: String` ID of the Invite. - `accepted_at: Time` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: String` Email of the User being invited. - `expires_at: Time` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: Time` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: Array[String]` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: BetaOrganizationRole` Organization role of the User. - `:admin` - `:billing` - `:claude_code_user` - `:developer` - `:managed` - `:membership_admin` - `:owner` - `:primary_owner` - `:user` - `status: :accepted | :deleted | :expired | :pending` Status of the Invite. - `:accepted` - `:deleted` - `:expired` - `:pending` ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") page = anthropic.beta.organization.invites.list puts(page) ``` #### Response (200) ```json { "data": [ { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ## Get Invite `beta.organization.invites.retrieve(invite_id) -> BetaOrganizationInvite` **GET** `/v1/organizations/invites/{invite_id}` Retrieve an invite by ID. ### Parameters - `invite_id: String` (path parameter) ID of the Invite. ### Returns - `class BetaOrganizationInvite` - `type: :invite` Object type. For Invites, this is always `"invite"`. - `id: String` ID of the Invite. - `accepted_at: Time` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: String` Email of the User being invited. - `expires_at: Time` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: Time` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: Array[String]` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: BetaOrganizationRole` Organization role of the User. - `:admin` - `:billing` - `:claude_code_user` - `:developer` - `:managed` - `:membership_admin` - `:owner` - `:primary_owner` - `:user` - `status: :accepted | :deleted | :expired | :pending` Status of the Invite. - `:accepted` - `:deleted` - `:expired` - `:pending` ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") beta_organization_invite = anthropic.beta.organization.invites.retrieve("invite_id") puts(beta_organization_invite) ``` #### Response (200) ```json { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } ``` ## Delete Invite `beta.organization.invites.delete(invite_id) -> InviteDeleteResponse` **DELETE** `/v1/organizations/invites/{invite_id}` Delete a pending invite. ### Parameters - `invite_id: String` (path parameter) ID of the Invite. ### Returns - `class InviteDeleteResponse` - `type: :invite_deleted` Deleted object type. For Invites, this is always `"invite_deleted"`. - `id: String` ID of the Invite. ### Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") invite = anthropic.beta.organization.invites.delete("invite_id") puts(invite) ``` #### Response (200) ```json { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "type": "invite_deleted" } ``` ## Domain types ### Beta Organization Invite - `class BetaOrganizationInvite` - `type: :invite` Object type. For Invites, this is always `"invite"`. - `id: String` ID of the Invite. - `accepted_at: Time` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: String` Email of the User being invited. - `expires_at: Time` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: Time` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: Array[String]` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: BetaOrganizationRole` Organization role of the User. - `:admin` - `:billing` - `:claude_code_user` - `:developer` - `:managed` - `:membership_admin` - `:owner` - `:primary_owner` - `:user` - `status: :accepted | :deleted | :expired | :pending` Status of the Invite. - `:accepted` - `:deleted` - `:expired` - `:pending` ### Invite Delete Response - `class InviteDeleteResponse` - `type: :invite_deleted` Deleted object type. For Invites, this is always `"invite_deleted"`. - `id: String` ID of the Invite.