Get a List of Managers

The method returns a List of Managers.

 GET /api/vendor/v1/managers.json?api_token={api_token}

Arguments

Name

Parameter Type

Data type

Required/ 
Optional

Description

api_tokenquerystringRequiredAPI token of the manager who perform the operation (see API Token Authentication)

page

query

integer

Optional

Returning a list of managers by current page number

per_page

query

integer

Optional

Setting a number of items in the page

sorting[field]

query

string

Optional

Sorting the list by the specified field

sorting[reversed]

query

string

Optional

Set the reversed sorting mode by the specified field:

  • true — descending sorting.
  • false — ascending sorting (by default).

filters[created_at]

query

date

Optional

Filtering the list by a creation date

filters[updated_at]

query

date

Optional

Filtering the list by an update date

filters[status]

query

string

Optional

Filtering the list by a status

Response model

Name

Data type

Description

id

integer

A manager ID

status

string

One of the following manager's status: 

  • active — a manager has access to the Operator Control Panel.
  • inactive — a manager doesn't have access to the Operator Control Panel.

name

string

A manager name

created_at

data

A date and time of the manager's creation

updated_at

data

A date and time of the manager's changes last time

Request example

 GET http://billing.activeplatform.com:80/api/vendor/v1/managers.json?api_token=654321

Response example

[
  {
    "id": 1,
    "status": "active",
    "name": "AK",
    "created_at": "2014-08-20T17:41:53.466+03:00",
    "updated_at": "2016-05-24T12:19:25.693+03:00"
  },
  {
    "id": 2000115,
    "status": "active",
    "name": "Anastasiya S",
    "created_at": "2014-12-01T15:32:46.202+03:00",
    "updated_at": "2015-08-17T14:39:54.611+03:00"
  }
]