OperatorAPI usertar:list

newadmapi (Operator API) function. Available to: Operator, SuperRoot.

Description

Lists the customer tariffs of the caller's tenant. Paginated, sorted and filtered on the declared fields only. `groups` and `root` are columns of the relation and are never published: one is an authority list, the other is scope.

Call

GET|POST https://YOUR_HOST:9089/newadm?func=usertar:list

Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).

Parameters

Parameter	Type	Required	Default	Meaning
order	string	No	tariff	Sort field. (id, tariff, description, mastertariff_id)
dir	string	No	asc	asc or desc.
page	integer	No	0	Zero-based page.
pagesize	integer	No	50	Rows per page.
filterby	string	No	—	Field to search. (tariff, description - a substring search over a key is not offered)
filter	string	No	—	Literal substring, case-insensitive.

Example

https://host:port/newadm?func=list&section=usertar&order=tariff

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape (n = number, s = string, ? = present only when set):

{
  "ok":true,
  "data":{
    "rows":[
      {
        "id":n,
        "tariff":s,
        "description":s,
        "mastertariff_id":n
      }
    ],
    "page":n,
    "pagesize":n,
    "fields":[
      s
    ],
    "available":[
      s
    ],
    "order":s,
    "dir":s,
    "filterby":s?,
    "filter":s?
  }
}

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

---

Back to OperatorAPI