getAdminsInfo

Getting all objects of user-admins

Admins.getAdminsInfo(body, langCode, offset, limit)

const value = await Admins.getAdminsInfo();

Schema

body: array
array of filter objects with search conditions
example: []

langCode: string
language code
example: en_US

offset: number
parameter for pagination, default 0
example: 0

limit number
parameter for pagination, default 30
example: 30

This method retrieves user objects of type admin from the API. It returns a Promise that resolves to an array of AdminEntity objects.

Example return:

[
  {
    "id": 1764,
    "identifier": "admin1",
    "attributeSetId": 7,
    "isSync": false,
    "attributeValues": {
      "marker": {
        "value": "",
        "type": "string"
      }
    },
    "position": 192
  }
]

Schema

id: number
object identifier
example: 1764

identifier: string
textual identifier for the record field
example: admin1
default: admin1

attributeSetId: number
Attribute set identifier
example: 7

isSync boolean
Page indexing flag (true or false)
example: false

attributeValues: Record<string, string>
Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value)
example:

{
  "en_US": {
    "marker": { 
      "value": "",
      "type": "string"
    }
  }
}

position: number
Position number (for sorting)
example: 192

---