v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
User

Get All Users

Returns all users for the current tenant with optional filtering and pagination. If includeRoles is true, the response includes roles for each user. If includeRoles is false or not provided, only user objects are returned without roles.

get/users

Query parameters

endAtIdstring

End at ID for pagination

filterstring

Filter string for querying users

includeRolesboolean

If true, includes roles for each user in the response. When true, the response returns a roles field for each user. When false or not provided, the response returns only user objects without roles.

pageinteger

Page number for pagination

searchUserstring

Search string to find users by first name, last name, or email. If provided, returns users matching the search criteria.

sizeinteger

Page size for pagination

startAfterIdstring

Start after ID for pagination

Headers

tenant-idstring

Response

Users retrieved successfully. When includeRoles is true, returns UserListResponseWithRolesDto containing users with their roles. When includeRoles is false or not provided, returns UserListResponseDto containing only user objects without roles.

OR

Example response

{
  "data": [
    {
      "createdAt": "2022-03-10T12:15:50-04:00",
      "updatedAt": "2022-03-10T12:15:50-04:00"
    }
  ]
}