Claude Platform Docs

Users

List Users
client.beta.organization.users.list(UserListParamsquery?, RequestOptionsoptions?): Page<BetaOrganizationUser>
GET/v1/organizations/users
Get User
client.beta.organization.users.retrieve(stringuserID, RequestOptionsoptions?): BetaOrganizationUser
GET/v1/organizations/users/{user_id}
Update User
client.beta.organization.users.update(stringuserID, UserUpdateParamsbody, RequestOptionsoptions?): BetaOrganizationUser
POST/v1/organizations/users/{user_id}
Remove User
client.beta.organization.users.remove(stringuserID, RequestOptionsoptions?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}
Models
BetaOrganizationUser { id, added_at, email, 3 more }
id: string

ID of the User.

added_at: string

RFC 3339 datetime string indicating when the User joined the Organization.

formatdate-time
email: string

Email of the User.

name: string

Name of the User.

role: BetaOrganizationRole

Organization role of the User.

One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
type: "user"

Object type.

For Users, this is always "user".

defaultuser
UserRemoveResponse { id, type }
id: string

ID of the User.

type: "user_deleted"

Deleted object type.

For Users, this is always "user_deleted".

defaultuser_deleted