API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

Create user

client.users.create(UserCreateParams { id, email, firstName, 5 more } body?, RequestOptionsoptions?): User { id, email, firstName, 5 more }

post/user

Creates list of users with given input array

client.users.createWithList(UserCreateWithListParams { items } params?, RequestOptionsoptions?): User { id, email, firstName, 5 more }

post/user/createWithList

Logs user into the system

client.users.login(UserLoginParams { password, username } query?, RequestOptionsoptions?): UserLoginResponse

get/user/login

Logs out current logged in user session

client.users.logout(RequestOptionsoptions?): void

get/user/logout

Get user by user name

client.users.retrieve(stringusername, RequestOptionsoptions?): User { id, email, firstName, 5 more }

get/user/{username}

Update user

client.users.update(stringexistingUsername, UserUpdateParams { id, email, firstName, 5 more } body?, RequestOptionsoptions?): void

put/user/{username}

Delete user

client.users.delete(stringusername, RequestOptionsoptions?): void

delete/user/{username}

ModelsExpand Collapse

User { id, email, firstName, 5 more }

id?: number

email?: string

firstName?: string

lastName?: string

password?: string

phone?: string

username?: string

userStatus?: number

User Status

formatint32