Skip to content
FRAGMENT
API Reference

Users

User management operations

Create
POST/users
List
GET/users
Update
PATCH/users/{user_ref}
ModelsExpand Collapse
User object { id, external_id, tags }

User object.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: array of object { key, value }

Tags for the user.

key: string

Tag key.

value: string

Tag value.

UserCreateResponse object { data }
data: User { id, external_id, tags }

User object.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: array of object { key, value }

Tags for the user.

key: string

Tag key.

value: string

Tag value.

UserListResponse object { data }

List of users.

data: array of User { id, external_id, tags }

List of users.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: array of object { key, value }

Tags for the user.

key: string

Tag key.

value: string

Tag value.

UserUpdateResponse object { data }
data: User { id, external_id, tags }

User object.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: array of object { key, value }

Tags for the user.

key: string

Tag key.

value: string

Tag value.