List Users

post/accountmanager.fetchusers

Retrieves a list of users.

Information: If the authenticated user does not have the explicit USER_FETCH permission, the fields are reduced to a minimum.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
endRow
number
Default: 300

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

oldValues
any
operationType
string non-empty
startRow
number

The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

textMatchStyle
string non-empty
object
_constructor
string non-empty
operator
string non-empty
Array of objects non-empty unique
Array (non-empty)
fieldName
string non-empty
operator
string non-empty

Specify an operator of the filter criteria.

Possible values: "equals" "iEquals" "notEqual" "iNotEqual" "isNull" "notNull" "contains" "iContains" "containsPattern" "iContainsPattern" "notContains" "iNotContains" "startsWith" "iStartsWith" "notStartsWith" "iNotStartsWith" "endsWith" "iEndsWith" "notEndsWith" "iNotEndsWith" … 4 more
value
boolean
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
startRow
number
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
loginName
string non-empty
firstName
string
lastName
string
email
string non-empty
activated
boolean
workflowEmailingActivated
boolean
noSession
boolean
requireTFA
boolean
receiveAdminEmail
boolean
ssoOnly
boolean
firstLogin
boolean
createDate
string non-empty
createdBy
number
lastLogin
string non-empty
lastUpdateBy
number
endRow
number
totalRows
number
status
number
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "workflowEmailingActivated",
        • "operator": "notEqual",
        • "value": true
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "loginName": "string",
        • "firstName": "string",
        • "lastName": "string",
        • "email": "string",
        • "activated": true,
        • "workflowEmailingActivated": true,
        • "noSession": true,
        • "requireTFA": true,
        • "receiveAdminEmail": true,
        • "ssoOnly": true,
        • "firstLogin": true,
        • "createDate": "string",
        • "createdBy": 0,
        • "lastLogin": "string",
        • "lastUpdateBy": 0
        }
      ],
    • "endRow": 0,
    • "totalRows": 0,
    • "status": 0
    }
}