--- title: Invites url: https://platform.claude.com/docs/en/api/go/organization/invites --- # Invites ## Create Invite `client.Organization.Invites.New(ctx, body) (*OrganizationInvite, error)` **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 - `body OrganizationInviteNewParams` - `Email string` Email of the User. format: email - `Role OrganizationInviteNewParamsRole` 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`. - `const OrganizationInviteNewParamsRoleBilling OrganizationInviteNewParamsRole = "billing"` - `const OrganizationInviteNewParamsRoleClaudeCodeUser OrganizationInviteNewParamsRole = "claude_code_user"` - `const OrganizationInviteNewParamsRoleDeveloper OrganizationInviteNewParamsRole = "developer"` - `const OrganizationInviteNewParamsRoleManaged OrganizationInviteNewParamsRole = "managed"` - `const OrganizationInviteNewParamsRoleUser OrganizationInviteNewParamsRole = "user"` - `RBACGroupIDs []string Optional` 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 - `type OrganizationInvite` - `Type Invite` Object type. For Invites, this is always `"invite"`. default: invite - `ID string` ID of the Invite. - `AcceptedAt Time` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `Email string` Email of the User being invited. - `ExpiresAt Time` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `InvitedAt Time` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `RBACGroupIDs []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 OrganizationRole` Organization role of the User. - `const OrganizationRoleAdmin OrganizationRole = "admin"` - `const OrganizationRoleBilling OrganizationRole = "billing"` - `const OrganizationRoleClaudeCodeUser OrganizationRole = "claude_code_user"` - `const OrganizationRoleDeveloper OrganizationRole = "developer"` - `const OrganizationRoleManaged OrganizationRole = "managed"` - `const OrganizationRoleMembershipAdmin OrganizationRole = "membership_admin"` - `const OrganizationRoleOwner OrganizationRole = "owner"` - `const OrganizationRolePrimaryOwner OrganizationRole = "primary_owner"` - `const OrganizationRoleUser OrganizationRole = "user"` - `Status OrganizationInviteStatus` Status of the Invite. - `const OrganizationInviteStatusAccepted OrganizationInviteStatus = "accepted"` - `const OrganizationInviteStatusDeleted OrganizationInviteStatus = "deleted"` - `const OrganizationInviteStatusExpired OrganizationInviteStatus = "expired"` - `const OrganizationInviteStatusPending OrganizationInviteStatus = "pending"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) organizationInvite, err := client.Organization.Invites.New(context.TODO(), anthropic.OrganizationInviteNewParams{ Email: "user@emaildomain.com", Role: anthropic.OrganizationInviteNewParamsRoleUser, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", organizationInvite.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 `client.Organization.Invites.List(ctx, query) (*Page[OrganizationInvite], error)` **GET** `/v1/organizations/invites` List the organization's invites. ### Parameters - `query OrganizationInviteListParams` - `AfterID param.Opt[string] Optional` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `BeforeID param.Opt[string] Optional` (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 param.Opt[string] Optional` (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 param.Opt[int64] Optional` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `Roles []string Optional` (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 []string Optional` (query parameter) Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. - `const OrganizationInviteListParamsStatusAccepted OrganizationInviteListParamsStatus = "accepted"` - `const OrganizationInviteListParamsStatusExpired OrganizationInviteListParamsStatus = "expired"` - `const OrganizationInviteListParamsStatusPending OrganizationInviteListParamsStatus = "pending"` ### Returns - `type OrganizationInvite` - `Type Invite` Object type. For Invites, this is always `"invite"`. default: invite - `ID string` ID of the Invite. - `AcceptedAt Time` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `Email string` Email of the User being invited. - `ExpiresAt Time` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `InvitedAt Time` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `RBACGroupIDs []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 OrganizationRole` Organization role of the User. - `const OrganizationRoleAdmin OrganizationRole = "admin"` - `const OrganizationRoleBilling OrganizationRole = "billing"` - `const OrganizationRoleClaudeCodeUser OrganizationRole = "claude_code_user"` - `const OrganizationRoleDeveloper OrganizationRole = "developer"` - `const OrganizationRoleManaged OrganizationRole = "managed"` - `const OrganizationRoleMembershipAdmin OrganizationRole = "membership_admin"` - `const OrganizationRoleOwner OrganizationRole = "owner"` - `const OrganizationRolePrimaryOwner OrganizationRole = "primary_owner"` - `const OrganizationRoleUser OrganizationRole = "user"` - `Status OrganizationInviteStatus` Status of the Invite. - `const OrganizationInviteStatusAccepted OrganizationInviteStatus = "accepted"` - `const OrganizationInviteStatusDeleted OrganizationInviteStatus = "deleted"` - `const OrganizationInviteStatusExpired OrganizationInviteStatus = "expired"` - `const OrganizationInviteStatusPending OrganizationInviteStatus = "pending"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Organization.Invites.List(context.TODO(), anthropic.OrganizationInviteListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 `client.Organization.Invites.Get(ctx, inviteID) (*OrganizationInvite, error)` **GET** `/v1/organizations/invites/{invite_id}` Retrieve an invite by ID. ### Parameters - `inviteID string` (path parameter) ID of the Invite. ### Returns - `type OrganizationInvite` - `Type Invite` Object type. For Invites, this is always `"invite"`. default: invite - `ID string` ID of the Invite. - `AcceptedAt Time` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `Email string` Email of the User being invited. - `ExpiresAt Time` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `InvitedAt Time` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `RBACGroupIDs []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 OrganizationRole` Organization role of the User. - `const OrganizationRoleAdmin OrganizationRole = "admin"` - `const OrganizationRoleBilling OrganizationRole = "billing"` - `const OrganizationRoleClaudeCodeUser OrganizationRole = "claude_code_user"` - `const OrganizationRoleDeveloper OrganizationRole = "developer"` - `const OrganizationRoleManaged OrganizationRole = "managed"` - `const OrganizationRoleMembershipAdmin OrganizationRole = "membership_admin"` - `const OrganizationRoleOwner OrganizationRole = "owner"` - `const OrganizationRolePrimaryOwner OrganizationRole = "primary_owner"` - `const OrganizationRoleUser OrganizationRole = "user"` - `Status OrganizationInviteStatus` Status of the Invite. - `const OrganizationInviteStatusAccepted OrganizationInviteStatus = "accepted"` - `const OrganizationInviteStatusDeleted OrganizationInviteStatus = "deleted"` - `const OrganizationInviteStatusExpired OrganizationInviteStatus = "expired"` - `const OrganizationInviteStatusPending OrganizationInviteStatus = "pending"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) organizationInvite, err := client.Organization.Invites.Get(context.TODO(), "invite_id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", organizationInvite.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 `client.Organization.Invites.Delete(ctx, inviteID) (*OrganizationInviteDeleteResponse, error)` **DELETE** `/v1/organizations/invites/{invite_id}` Delete a pending invite. ### Parameters - `inviteID string` (path parameter) ID of the Invite. ### Returns - `type OrganizationInviteDeleteResponse` - `Type InviteDeleted` Deleted object type. For Invites, this is always `"invite_deleted"`. default: invite_deleted - `ID string` ID of the Invite. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) invite, err := client.Organization.Invites.Delete(context.TODO(), "invite_id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", invite.ID) } ``` #### Response (200) ```json { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "type": "invite_deleted" } ``` ## Domain types ### Organization Invite - `type OrganizationInvite` - `Type Invite` Object type. For Invites, this is always `"invite"`. default: invite - `ID string` ID of the Invite. - `AcceptedAt Time` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `Email string` Email of the User being invited. - `ExpiresAt Time` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `InvitedAt Time` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `RBACGroupIDs []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 OrganizationRole` Organization role of the User. - `const OrganizationRoleAdmin OrganizationRole = "admin"` - `const OrganizationRoleBilling OrganizationRole = "billing"` - `const OrganizationRoleClaudeCodeUser OrganizationRole = "claude_code_user"` - `const OrganizationRoleDeveloper OrganizationRole = "developer"` - `const OrganizationRoleManaged OrganizationRole = "managed"` - `const OrganizationRoleMembershipAdmin OrganizationRole = "membership_admin"` - `const OrganizationRoleOwner OrganizationRole = "owner"` - `const OrganizationRolePrimaryOwner OrganizationRole = "primary_owner"` - `const OrganizationRoleUser OrganizationRole = "user"` - `Status OrganizationInviteStatus` Status of the Invite. - `const OrganizationInviteStatusAccepted OrganizationInviteStatus = "accepted"` - `const OrganizationInviteStatusDeleted OrganizationInviteStatus = "deleted"` - `const OrganizationInviteStatusExpired OrganizationInviteStatus = "expired"` - `const OrganizationInviteStatusPending OrganizationInviteStatus = "pending"`