--- title: Invites url: https://platform.claude.com/docs/en/api/python/organization/invites --- # Invites ## Create Invite `organization.invites.create(**kwargs) -> OrganizationInvite` **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: str` Email of the User. format: email - `role: Literal["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`. - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"user"` - `rbac_group_ids: Optional[Sequence[str]]` 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 OrganizationInvite` - `type: Literal["invite"]` Object type. For Invites, this is always `"invite"`. default: invite - `id: str` ID of the Invite. - `accepted_at: Optional[datetime]` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: str` Email of the User being invited. - `expires_at: datetime` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: datetime` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: List[str]` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: OrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` - `status: Literal["accepted", "deleted", "expired", "pending"]` Status of the Invite. - `"accepted"` - `"deleted"` - `"expired"` - `"pending"` ### Example ```python import os from anthropic import Anthropic client = Anthropic( api_key=os.environ.get( "ANTHROPIC_API_KEY" ), # This is the default and can be omitted ) organization_invite = client.organization.invites.create( email="user@emaildomain.com", role="user", ) print(organization_invite.id) ``` #### 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 `organization.invites.list(**kwargs) -> SyncPage[OrganizationInvite]` **GET** `/v1/organizations/invites` List the organization's invites. ### Parameters - `after_id: Optional[str]` (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: Optional[str]` (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: Optional[str]` (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: Optional[int]` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `roles: Optional[Sequence[str]]` (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: Optional[List[Literal["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 OrganizationInvite` - `type: Literal["invite"]` Object type. For Invites, this is always `"invite"`. default: invite - `id: str` ID of the Invite. - `accepted_at: Optional[datetime]` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: str` Email of the User being invited. - `expires_at: datetime` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: datetime` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: List[str]` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: OrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` - `status: Literal["accepted", "deleted", "expired", "pending"]` Status of the Invite. - `"accepted"` - `"deleted"` - `"expired"` - `"pending"` ### Example ```python import os from anthropic import Anthropic client = Anthropic( api_key=os.environ.get( "ANTHROPIC_API_KEY" ), # This is the default and can be omitted ) page = client.organization.invites.list() page = page.data[0] print(page.id) ``` #### 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 `organization.invites.retrieve(invite_id) -> OrganizationInvite` **GET** `/v1/organizations/invites/{invite_id}` Retrieve an invite by ID. ### Parameters - `invite_id: str` (path parameter) ID of the Invite. ### Returns - `class OrganizationInvite` - `type: Literal["invite"]` Object type. For Invites, this is always `"invite"`. default: invite - `id: str` ID of the Invite. - `accepted_at: Optional[datetime]` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: str` Email of the User being invited. - `expires_at: datetime` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: datetime` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: List[str]` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: OrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` - `status: Literal["accepted", "deleted", "expired", "pending"]` Status of the Invite. - `"accepted"` - `"deleted"` - `"expired"` - `"pending"` ### Example ```python import os from anthropic import Anthropic client = Anthropic( api_key=os.environ.get( "ANTHROPIC_API_KEY" ), # This is the default and can be omitted ) organization_invite = client.organization.invites.retrieve( "invite_id", ) print(organization_invite.id) ``` #### 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 `organization.invites.delete(invite_id) -> InviteDeleteResponse` **DELETE** `/v1/organizations/invites/{invite_id}` Delete a pending invite. ### Parameters - `invite_id: str` (path parameter) ID of the Invite. ### Returns - `class InviteDeleteResponse` - `type: Literal["invite_deleted"]` Deleted object type. For Invites, this is always `"invite_deleted"`. default: invite_deleted - `id: str` ID of the Invite. ### Example ```python import os from anthropic import Anthropic client = Anthropic( api_key=os.environ.get( "ANTHROPIC_API_KEY" ), # This is the default and can be omitted ) invite = client.organization.invites.delete( "invite_id", ) print(invite.id) ``` #### Response (200) ```json { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "type": "invite_deleted" } ``` ## Domain types ### Organization Invite - `class OrganizationInvite` - `type: Literal["invite"]` Object type. For Invites, this is always `"invite"`. default: invite - `id: str` ID of the Invite. - `accepted_at: Optional[datetime]` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: str` Email of the User being invited. - `expires_at: datetime` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: datetime` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: List[str]` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: OrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` - `status: Literal["accepted", "deleted", "expired", "pending"]` Status of the Invite. - `"accepted"` - `"deleted"` - `"expired"` - `"pending"` ### Invite Delete Response - `class InviteDeleteResponse` - `type: Literal["invite_deleted"]` Deleted object type. For Invites, this is always `"invite_deleted"`. default: invite_deleted - `id: str` ID of the Invite.