Users

Last updated 18 days ago

Users ​

Base path: /v1/users · Auth: Bearer

MethodPathPurpose
GET/v1/usersList users (pagination/filter)
POST/v1/usersCreate a user
GET/v1/users/meCurrent profile
PATCH/v1/users/meUpdate your own profile
GET/v1/users/{userId}Retrieve a user
PATCH/v1/users/{userId}Update a user
DELETE/v1/users/{userId}Delete a user

Query (GET /v1/users) ​

Pagination (page, pageSize, search, sort) plus:

ParameterTypeDescription
statusenum active | inactive | suspendedFilter by status
roleenum admin | user | guestFilter by role
teamUUIDFilter by team

Body — create (POST /v1/users) ​

FieldTypeRequiredDescription
mailstring (email)✅Email
first_namestring✅First name
last_namestring✅Last name
roleenum admin | user | guest–Role
teamsUUID[]–Team memberships
countrystring (2 characters)–Country code
localestring–Locale
timezoneinteger–Timezone offset
languagesstring[]–Languages
sidstring–Custom short ID

Body — update (PATCH /v1/users/{userId} or /me) ​

All optional: status (active/inactive/suspended), first_name, last_name, avatar, color (#RRGGBB), role, teams, country, locale, timezone, languages, darkmode (auto/light/dark).

Example ​

bash
bash