Search K
Appearance
Get users.
GET
/backend/v1/users
Retrieves a list of users matching the given filter criteria,
with the option to adjust the limit for more results.
Authorizations
HTTPBearer
TypeHTTP (bearer)
Parameters
Query Parameters
search
User's name or email address for filtering results
cursor
Selects page for paginated results. Pass in the next or prev attribute in the response
limit
Number of results to return.
Typeinteger
default
10project
If provided, returns only users in that project
groupId
If provided, returns only users in the specified group.
roleId
If provided, returns only users assigned to that role
includeRoles
Include all of the roles from the returned users in the response.
Typeboolean
default
falseResponses
Successful Response
application/json
JSON
{
"next": "string",
"prev": "string",
"roles": {
"additionalProperties": {
}
},
"users": [
{
"admin": "string",
"blocked": false,
"createdAt": "string",
"email": "string",
"id": "string",
"lastInvitationSentAt": "string",
"machine": false,
"name": "string",
"org": "string",
"permissions": [
[
]
],
"roleIds": [
[
]
],
"roles": [
[
]
],
"social": false,
"teams": [
[
]
],
"verified": true
}
]
}