Skip to content

List users

Request

Returns a paginated list of users within the specified organization.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

Query
SearchTextstring

Filter users by a free-text search across given name, surname, and email.

GivenNamestring

Filter users by given name.

Surnamestring

Filter users by surname.

Emailstring

Filter users by email address.

Pageinteger, (int32)

The page number.

PageSizeinteger, (int32)

The number of items per page.

SortingKeystring(UserSortingKey)

The sorting key.

Enum:"GivenName""Surname""Email"
Ascendingboolean

Whether to sort in ascending order.

GET
/api/v1/organizations/{organizationId}/users
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/users?SearchText=string&GivenName=string&Surname=string&Email=string&Page=0&PageSize=0&SortingKey=GivenName&Ascending=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
usersArray of objects(UserSummary)required

The list of users.

paginationobject(PaginationResponse)required

Pagination metadata.

Response
{ "users": [ { … } ], "pagination": { "page": 0, "pageSize": 0, "totalCount": 0 } }