Skip to main content

Get operators​

x-ms-visibility: "important"

Get a list of operators. Possible values for SigninType: Federated, emailAddress

Query Parameters
    page int32

    Page to be fetched. Default: 1

    limit int32

    Limit (No. of records per page). Max value: 100. Default: 100.

    sortKey string

    Sort field to be used. Supported values are 'name' and 'email'. Default: 'email'

    sortDescending boolean

    Set to 'true' to sort descending based on sort key. Default: 'false'

    search string

    Free text filter for operators based on name or email.

    homeSite int32

    Operator home site id.

    roleIds int32[]

    Array of role IDs to filter the operators by their roles. If not provided, all operators are returned.

Responses

List of operators

Schema
    page int32
    limit int32
    totalRecords int32
    hasNextPage boolean
    hasPreviousPage boolean
    items object[]
  • Array [
    • id string
    name string
    email string
    homeSiteId int64 nullable
    homeSiteName string
    permissions string[]
    assignedPermissions string[]
    roles object[]
  • Array [
    • id int64
    name string
    permissions string[]

    Possible values: [SystemAdmin, GlobalAdmin, SiteAdmin, ReadTariffs, WriteTariffs, ReadChargers, WriteChargers, ReadSites, WriteSites, OperateChargers, UpdateChargerFirmware, ReadDrivers, WriteDrivers, ReadSessions, ReadTags, WriteTags, ReadPaymentTerminals, WritePaymentTerminals, ReadIntegrations, WriteIntegrations, ReadBilling, WriteBilling, ReadInvoicing, ReadDLM, WriteDLM, ReadExpress, WriteExpress]

  • ]
    • signInTypes object[]
  • Array [
    • name string
    type string
    id int64 nullable
  • ]
  • ]
Loading...