Skip to content
FRAGMENT
API Reference

Users

Create
client.users.create(UserCreateParams { external_id, tags } body, RequestOptionsoptions?): UserCreateResponse { data }
POST/users
List
client.users.list(RequestOptionsoptions?): UserListResponse { data }
GET/users
Update
client.users.update(stringuserRef, UserUpdateParams { tags } body, RequestOptionsoptions?): UserUpdateResponse { data }
PATCH/users/{user_ref}
ModelsExpand Collapse
User { id, external_id, tags }

User object.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: Array<Tag>

Tags for the user.

key: string

Tag key.

value: string

Tag value.