Skip to content

Get active account users

Request

This endpoint returns active users associated with the current account, supporting keyword-based filtering, sorting, and pagination.

Behavior:

  • Only users in active status are included
  • User data is retrieved from the account cache
  • The response contains a paginated and sorted user list
Query
startstring
Body
keywordstring or null
sortColumnstring or null
sortOrderstring or null
isTileViewboolean
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/account/users/active?start=string' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "keyword": "string",
    "sortColumn": "string",
    "sortOrder": "string",
    "isTileView": true
  }'

Responses

OK

Body
dataobject(Models.UserListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger, (int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
{
  "data": {
    "data": [
      {
        "userRoleModels": [
          {
            "userRoleId": "68ac681d-d2dd-4a76-b9b9-ea57ce43a8a0",
            "userRoleName": "string",
            "noofUsers": 0,
            "users": [
              {}
            ],
            "privileges": [
              {}
            ],
            "isLicensed": true,
            "isDefault": true,
            "responseDescription": "string"
          }
        ],
        "activationDateString": "string",
        "expiryDateString": "string",
        "responseDescription": "string",
        "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
        "name": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "phoneNumber1": "string",
        "phoneNumber2": "string",
        "accountAccess": {
          "loginName": "string",
          "resetPasswordState": true,
          "activationDate": "2019-08-24T14:15:22Z",
          "expiryDate": "2019-08-24T14:15:22Z"
        },
        "status": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "code": "string"
        },
        "email": "string",
        "timezone": {
          "timezoneId": "ec6fffce-51c8-4aa2-b751-ebde3e12856f",
          "timezoneName": "string",
          "code": "string",
          "supportsDaylightSavingTime": true,
          "daylightName": "string"
        },
        "profilePic": "string",
        "userIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "isSSOUser": true,
        "userRoles": [
          "string"
        ],
        "statusCode": "string",
        "team": {
          "accountOrgUnitId": "b9e3953d-56f9-4bc0-9b59-60fd4682ccf6",
          "levelOrdinal": 0,
          "accountOrgUnitName": "string",
          "accountOrgUnitCode": "string",
          "parentAccountOrgUnitId": "d148c557-9fa6-487a-85c9-8fd3a8f5a469",
          "subLevelUnits": [
            {}
          ]
        },
        "loginName": "string",
        "statusDetails": {
          "statusId": 0,
          "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
          "statusName": "string",
          "statusCode": "string",
          "statusColor": "string"
        },
        "isEmployee": true,
        "employeeCode": "string",
        "isTwoFactorEnabled": true
      }
    ],
    "listProperties": {
      "totalCount": 0,
      "currentStart": 0,
      "currentLength": 0,
      "pageCount": 0
    }
  },
  "message": "string",
  "isError": true,
  "messageCode": 0,
  "status": "string",
  "errorType": "string",
  "traceid": "string",
  "responseDescription": "string"
}