Skip to content

Retrieve all users with optional filters and pagination

Request

Security
bearer
Query
searchstring

Search across firstName, lastName, and email

Example:search=john
roleArray of strings

Filter by user role(s)

Items Enum:"ORGANIZATION_USER""BRAND_USER""SITE_USER""CLIENT_ACCOUNT_USER""SITE_MANAGER_USER"
Example:role=CLIENT_ACCOUNT_USER
isEnabledbooleanrequired

Filter by enabled status

Example:isEnabled=true
isAdminbooleanrequired

Filter by admin status

Example:isAdmin=true
clientAccountIdArray of numbers

Filter by client account IDs

Example:clientAccountId=1&clientAccountId=2
organizationIdArray of numbers

Filter by organization IDs

Example:organizationId=1&organizationId=2
brandIdArray of numbers

Filter by brand IDs

Example:brandId=1&brandId=2
siteIdArray of numbers

Filter by site IDs

Example:siteId=1&siteId=2
onlyAcceptedTOSbooleanrequired

Accepted TOS

Example:onlyAcceptedTOS=true
pagenumber, >= 0

Page number (0-based)

Default:0
Example:page=0
pageSizenumber, [ 1 .. 100 ]

Number of items per page

Default:10
Example:pageSize=10
fieldstring

Field to sort by

Enum:"id""firstName""lastName""email""isEnabled""createdAt""updatedAt"
Example:field=createdAt
sortBy[0][field]string

First sort field

Enum:"id""firstName""lastName""email""isEnabled""createdAt""updatedAt"
sortBy[0][dir]string

First sort direction

Enum:"asc""desc"
sortBy[1][field]string

Second sort field

Enum:"id""firstName""lastName""email""isEnabled""createdAt""updatedAt"
sortBy[1][dir]string

Second sort direction

Enum:"asc""desc"
curl -i -X GET \
  'https://docs.axiomera.com/_mock/apis/heydonto/openapi/users?search=john&role=CLIENT_ACCOUNT_USER&isEnabled=true&isAdmin=true&clientAccountId=1%2C2&organizationId=1%2C2&brandId=1%2C2&siteId=1%2C2&onlyAcceptedTOS=true&page=0&pageSize=10&field=createdAt&sortBy%5B0%5D%5Bfield%5D=id&sortBy%5B0%5D%5Bdir%5D=asc&sortBy%5B1%5D%5Bfield%5D=id&sortBy%5B1%5D%5Bdir%5D=asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of users retrieved successfully.

Bodyapplication/json
dataArray of objects(UserDto)required

Array of users

metaobject(PaginationMetaDto)required

Pagination metadata

Response
{ "data": [ { … } ], "meta": { "page": 0, "pageSize": 10, "total": 150, "totalPages": 15, "hasNext": true, "hasPrevious": false } }