Skip to content
Catalyzed Docs

List users

GET
/users

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
userIds
string
nullable
userEmails
string
nullable
teamIds
string
nullable
fullNameLike
string
nicknameLike
string
page
number
>= 1
pageSize
number
>= 1 <= 100
orderBy
string
Allowed values: createdAt fullName
orderDirection
string
Allowed values: asc desc

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Users retrieved successfully

object
users
required
Array<object>
object
userId
required
string
fullName
required
string
nickname
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
total
required
number
page
required
number
pageSize
required
number

403

Section titled “403 ”

Forbidden - insufficient permissions to access requested users