Skip to content
FRAGMENT
API Reference

Users

User management operations

Create
users.create(UserCreateParams**kwargs) -> UserCreateResponse
POST/users
List
users.list() -> UserListResponse
GET/users
Update
users.update(struser_ref, UserUpdateParams**kwargs) -> UserUpdateResponse
PATCH/users/{user_ref}
ModelsExpand Collapse
class User: …

User object.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

tags: List[Tag]

Tags for the user.

key: str

Tag key.

value: str

Tag value.

class UserCreateResponse: …
data: User

User object.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

tags: List[Tag]

Tags for the user.

key: str

Tag key.

value: str

Tag value.

class UserListResponse: …

List of users.

data: List[User]

List of users.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

tags: List[Tag]

Tags for the user.

key: str

Tag key.

value: str

Tag value.

class UserUpdateResponse: …
data: User

User object.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

tags: List[Tag]

Tags for the user.

key: str

Tag key.

value: str

Tag value.