Get /api/v3/user

Operation: GetUsersV3

Summary
Path and Query Parameters
Filters
Response Parameters
- HTTP 200
  - Response Body Parameters
    - application/json
Responses
- HTTP 200
  - Response Body
    - application/json

Summary

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

Path and Query Parameters

Parameter	Description	Type	Location
filter		string	Query

Filters

Name	Description	Type	Operators
canManageFlags	Only users that can manage flags	boolean	equals

Response Parameters

HTTP 200

Body Parameters

Content Type: application/json

Type Reference: UserResponse [Array]

Parameter	Description	Type
array
userId	User Identifier	integer
userCode	User Code	string
fullName	Full name of the user	string
userRole		SystemUserRoleChild
userRoleId	The user role identifier	integer
userRoleInfo	The user role name	string
costCenter		TopmostCostCenter
isMultiTopmostCostCenter	User’s topmost combines multiple cost centers	boolean
multiTopmostCostCenters		CostCenterChild [Array]
costCenterId	The cost center identifier	integer
costCenterCode	The cost center code	string
costCenterInfo	The cost center info	string
costCenterId	The cost center identifier	integer
costCenterCode	The cost center code	string
costCenterInfo	The cost center info	string
place		TopmostPlace
isMultiTopmostPlace	User’s topmost combines multiple places	boolean
multiTopmostPlaces		PlaceChild [Array]
placeType		PlaceTypeResponse
placeTypeId	The place type identifier	integer
placeTypeCode	The place type code	string
placeTypeInfo	The place type info	string
structure	Indicates if the place is a structure	boolean
icon		Icon
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
placeEntityType		PlaceEntityTypeV202406
placeEntityTypeId	The place entity type identifier	integer
placeEntityTypeInfo	The place entity type name	string
isSystemPlaceType	Flag to indicate if the place type is a system-level place type	boolean
isDataRolledUp	Tells whether or not the place’s data is rolled up to its parents.	boolean
placeId	The place identifier	integer
placeCode	The place code	string
placeInfo	The place info	string
placeType		PlaceTypeResponse
placeTypeId	The place type identifier	integer
placeTypeCode	The place type code	string
placeTypeInfo	The place type info	string
structure	Indicates if the place is a structure	boolean
icon		Icon
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
placeEntityType		PlaceEntityTypeV202406
placeEntityTypeId	The place entity type identifier	integer
placeEntityTypeInfo	The place entity type name	string
isSystemPlaceType	Flag to indicate if the place type is a system-level place type	boolean
isDataRolledUp	Tells whether or not the place’s data is rolled up to its parents.	boolean
placeId	The place identifier	integer
placeCode	The place code	string
placeInfo	The place info	string
collection		TopmostCollection
isMultiTopmostCollection	User’s topmost combines multiple collections	boolean
multiTopmostCollections		CollectionChild [Array]
collectionId	The collection identifier	integer
collectionCode	The collection code	string
collectionInfo	The collection info	string
collectionIcon		Icon
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
collectionCode	The collection code	string
collectionInfo	The collection info	string
collectionIcon		Icon
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
activeDirectory	Is this a active directory user?	boolean
active	User is active or inactive	boolean
email	Email ID of the user	string
passwordExpirationInterval	Days until password expires	integer
strongPassword	Does user need a strong password - at least 8 character long, one upper case, one number, one special char	boolean
forcePasswordChange	Should the user be forced to change password on next login	boolean
maxApprovalAmount	Max Total cost of bill this user is allowed to approve	integer
lastLogin	last time the user logged in	string
reportGroup		ReportGroupChildResponse
reportGroupId		integer
reportGroupCode		string
reportGroupInfo		string
externalUserId	The external identifier for the user. This is only used for federated login.	string
userGroups	List of groups a user is a part of	UserGroupChild [Array]
userGroupId	The user group identifier	integer
userGroupName	The user group name	string
space		TopmostSpace
isMultiTopmostPlace	User’s topmost combines multiple places	boolean
multiTopmostPlaces		PlaceChild [Array]
placeType		PlaceTypeResponse
placeTypeId	The place type identifier	integer
placeTypeCode	The place type code	string
placeTypeInfo	The place type info	string
structure	Indicates if the place is a structure	boolean
icon		Icon
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
placeEntityType		PlaceEntityTypeV202406
placeEntityTypeId	The place entity type identifier	integer
placeEntityTypeInfo	The place entity type name	string
isSystemPlaceType	Flag to indicate if the place type is a system-level place type	boolean
isDataRolledUp	Tells whether or not the place’s data is rolled up to its parents.	boolean
placeId	The place identifier	integer
placeCode	The place code	string
placeInfo	The place info	string
placeType		PlaceTypeResponse
placeTypeId	The place type identifier	integer
placeTypeCode	The place type code	string
placeTypeInfo	The place type info	string
structure	Indicates if the place is a structure	boolean
icon		Icon
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
placeEntityType		PlaceEntityTypeV202406
placeEntityTypeId	The place entity type identifier	integer
placeEntityTypeInfo	The place entity type name	string
isSystemPlaceType	Flag to indicate if the place type is a system-level place type	boolean
isDataRolledUp	Tells whether or not the place’s data is rolled up to its parents.	boolean
placeId	The place identifier	integer
placeCode	The place code	string
placeInfo	The place info	string

Responses

HTTP 200

Body

Content Type: application/json

[
  {
    "userId": 1,
    "userCode": "string",
    "fullName": "string",
    "userRole": {
      "userRoleId": 1,
      "userRoleInfo": "string"
    },
    "costCenter": {
      "isMultiTopmostCostCenter": false,
      "multiTopmostCostCenters": [
        {
          "costCenterId": 1,
          "costCenterCode": "string",
          "costCenterInfo": "string"
        }
      ],
      "costCenterId": 1,
      "costCenterCode": "string",
      "costCenterInfo": "string"
    },
    "place": {
      "isMultiTopmostPlace": false,
      "multiTopmostPlaces": [
        {
          "placeType": {
            "placeTypeId": 1,
            "placeTypeCode": "string",
            "placeTypeInfo": "string",
            "structure": false,
            "icon": {
              "code": "string",
              "color": "string"
            },
            "placeEntityType": {
              "placeEntityTypeId": 1,
              "placeEntityTypeInfo": "string"
            },
            "isSystemPlaceType": false
          },
          "isDataRolledUp": false,
          "placeId": 1,
          "placeCode": "string",
          "placeInfo": "string"
        }
      ],
      "placeType": {
        "placeTypeId": 1,
        "placeTypeCode": "string",
        "placeTypeInfo": "string",
        "structure": false,
        "icon": {
          "code": "string",
          "color": "string"
        },
        "placeEntityType": {
          "placeEntityTypeId": 1,
          "placeEntityTypeInfo": "string"
        },
        "isSystemPlaceType": false
      },
      "isDataRolledUp": false,
      "placeId": 1,
      "placeCode": "string",
      "placeInfo": "string"
    },
    "collection": {
      "isMultiTopmostCollection": false,
      "multiTopmostCollections": [
        {
          "collectionId": 1,
          "collectionCode": "string",
          "collectionInfo": "string",
          "collectionIcon": {
            "code": "string",
            "color": "string"
          }
        }
      ],
      "collectionId": 1,
      "collectionCode": "string",
      "collectionInfo": "string",
      "collectionIcon": {
        "code": "string",
        "color": "string"
      }
    },
    "activeDirectory": false,
    "active": false,
    "email": "string",
    "passwordExpirationInterval": 1,
    "strongPassword": false,
    "forcePasswordChange": false,
    "maxApprovalAmount": 1,
    "lastLogin": "2025-03-20",
    "reportGroup": {
      "reportGroupId": 1,
      "reportGroupCode": "string",
      "reportGroupInfo": "string"
    },
    "externalUserId": "string",
    "userGroups": [
      {
        "userGroupId": 1,
        "userGroupName": "string"
      }
    ],
    "space": {
      "isMultiTopmostPlace": false,
      "multiTopmostPlaces": [
        {
          "placeType": {
            "placeTypeId": 1,
            "placeTypeCode": "string",
            "placeTypeInfo": "string",
            "structure": false,
            "icon": {
              "code": "string",
              "color": "string"
            },
            "placeEntityType": {
              "placeEntityTypeId": 1,
              "placeEntityTypeInfo": "string"
            },
            "isSystemPlaceType": false
          },
          "isDataRolledUp": false,
          "placeId": 1,
          "placeCode": "string",
          "placeInfo": "string"
        }
      ],
      "placeType": {
        "placeTypeId": 1,
        "placeTypeCode": "string",
        "placeTypeInfo": "string",
        "structure": false,
        "icon": {
          "code": "string",
          "color": "string"
        },
        "placeEntityType": {
          "placeEntityTypeId": 1,
          "placeEntityTypeInfo": "string"
        },
        "isSystemPlaceType": false
      },
      "isDataRolledUp": false,
      "placeId": 1,
      "placeCode": "string",
      "placeInfo": "string"
    }
  }
]