API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

Create user

users.create(UserCreateParams**kwargs) -> User

POST/user

Creates list of users with given input array

users.create_with_list(UserCreateWithListParams**kwargs) -> User

POST/user/createWithList

Logs user into the system

users.login(UserLoginParams**kwargs) -> UserLoginResponse

GET/user/login

Logs out current logged in user session

users.logout()

GET/user/logout

Get user by user name

users.retrieve(strusername) -> User

GET/user/{username}

Update user

users.update(strexisting_username, UserUpdateParams**kwargs)

PUT/user/{username}

Delete user

users.delete(strusername)

DELETE/user/{username}

ModelsExpand Collapse

class User: …

id: Optional[int]

email: Optional[str]

first_name: Optional[str]

last_name: Optional[str]

password: Optional[str]

phone: Optional[str]

username: Optional[str]

user_status: Optional[int]

User Status

formatint32