GET /api/v202512/user/paginated

Gets a paginated list of users. Requires View permission for Users & Roles. If this permission is not available, restricted set of properties are returned.

GetUsersPaginatedV202512 Paginated
Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Query Parameters

Name Description Type Required
filter string (string) Optional
orderBy string (string) Optional
pageSize The number of elements to return in a page integer (int32) Optional
pageNumber The current page number integer (int32) Optional

Filters

Filter Description Type Operators
active User is Active Boolean equals
canManageFlags Only users that can manage flags Boolean equals
email Email Address String equals not equals one of like not like not one of
fullName Full Name String equals not equals one of like not like not one of
systemUserCode Username String equals not equals one of like not like not one of
systemUserID Integer equals not equals less than between one of greater than less than equal greater than equal not one of
userGroupID Integer equals not equals less than between one of greater than less than equal greater than equal not one of

Order By Options

Name Description
systemUserID
fullName Full Name
systemUserCode Username
email Email Address
systemUserRoleName System User Role Name
placeCode Place Code
placeInfo Place Name
costCenterCode Cost Center Code
costCenterInfo Cost Center Name
collectionCode Collection Code
collectionInfo Collection Name
lastLogin Last Login

Response Headers

This endpoint returns pagination metadata in the response headers.

Header Type Description
PageNumber integer The current page number (1-based).
PageSize integer The maximum number of items per page.
TotalNumberOfRecords integer The total number of records matching the query across all pages.
TotalPages integer The total number of pages. Increment pageNumber until it equals this value to retrieve all results.

See the Pagination guide for iteration examples and best practices.

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

UserResponse
Property Description Type
active User is active or inactive boolean
activeDirectory Is this a active directory user? boolean
collection TopmostCollection
TopmostCollection properties
Property Description Type
collectionCode The collection code string
collectionIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
collectionId The collection identifier integer (int32)
collectionInfo The collection info string
isMultiTopmostCollection User’s topmost combines multiple collections boolean
multiTopmostCollections CollectionChild[]
CollectionChild properties
Property Description Type
collectionCode The collection code string
collectionIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
collectionId The collection identifier integer (int32)
collectionInfo The collection info string
costCenter TopmostCostCenter
TopmostCostCenter properties
Property Description Type
costCenterCode The cost center code string
costCenterId The cost center identifier integer (int32)
costCenterInfo The cost center info string
isMultiTopmostCostCenter User’s topmost combines multiple cost centers boolean
multiTopmostCostCenters CostCenterChild[]
CostCenterChild properties
Property Description Type
costCenterCode The cost center code string
costCenterId The cost center identifier integer (int32)
costCenterInfo The cost center info string
email Email ID of the user string
externalUserId The external identifier for the user. This is only used for federated login. string
forcePasswordChange Should the user be forced to change password on next login boolean
fullName Full name of the user string
lastLogin last time the user logged in string (date-time)
maxApprovalAmount Max Total cost of bill this user is allowed to approve integer (int32)
passwordExpirationInterval Days until password expires integer (int32)
place TopmostPlace
TopmostPlace properties
Property Description Type
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
isMultiTopmostPlace User’s topmost combines multiple places boolean
multiTopmostPlaces PlaceChild[]
PlaceChild properties
Property Description Type
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
placeCode The place code string
placeId The place identifier integer (int32)
placeInfo The place info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
placeCode The place code string
placeId The place identifier integer (int32)
placeInfo The place info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
reportGroup ReportGroupChildResponse
ReportGroupChildResponse properties
Property Description Type
reportGroupCode string
reportGroupId integer (int32)
reportGroupInfo string
space TopmostSpace
TopmostSpace properties
Property Description Type
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
isMultiTopmostPlace User’s topmost combines multiple places boolean
multiTopmostPlaces PlaceChild[]
PlaceChild properties
Property Description Type
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
placeCode The place code string
placeId The place identifier integer (int32)
placeInfo The place info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
placeCode The place code string
placeId The place identifier integer (int32)
placeInfo The place info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
strongPassword Does user need a strong password - at least 8 character long, one upper case, one number, one special char boolean
userCode User Code string
userGroups List of groups a user is a part of UserGroupChild[]
UserGroupChild properties
Property Description Type
userGroupId The user group identifier integer (int32)
userGroupName The user group name string
userId User Identifier integer (int32)
userRole SystemUserRoleChild
SystemUserRoleChild properties
Property Description Type
userRoleId The user role identifier integer (int32)
userRoleInfo The user role name string
Example Response application/json 
[
  {    "active": false,    "activeDirectory": false,    "collection": {      "collectionCode": "string",      "collectionIcon": {},      "collectionId": 1,      "collectionInfo": "string",      "isMultiTopmostCollection": false,      "multiTopmostCollections": []
    },    "costCenter": {      "costCenterCode": "string",      "costCenterId": 1,      "costCenterInfo": "string",      "isMultiTopmostCostCenter": false,      "multiTopmostCostCenters": []
    },    "email": "string",    "externalUserId": "string",    "forcePasswordChange": false,    "fullName": "string",    "lastLogin": "2026-03-30",    "maxApprovalAmount": 1,    "passwordExpirationInterval": 1,    "place": {      "isDataRolledUp": false,      "isMultiTopmostPlace": false,      "multiTopmostPlaces": [],      "placeCode": "string",      "placeId": 1,      "placeInfo": "string",      "placeType": {}
    },    "reportGroup": {      "reportGroupCode": "string",      "reportGroupId": 1,      "reportGroupInfo": "string"
    },    "space": {      "isDataRolledUp": false,      "isMultiTopmostPlace": false,      "multiTopmostPlaces": [],      "placeCode": "string",      "placeId": 1,      "placeInfo": "string",      "placeType": {}
    },    "strongPassword": false,    "userCode": "string",    "userGroups": [
      {      "userGroupId": 1,      "userGroupName": "string"
    }
    ],    "userId": 1,    "userRole": {      "userRoleId": 1,      "userRoleInfo": "string"
    }
  }
]