Get a List of the Reseller's Managers

The Get a List of the Reseller's Managers method returns the list of Managers of the current Reseller or any of its downstream Resellers.

Access to the current Reseller and downstream Resellers is determined by the Manager's token in the API request.

GET {base_url}/api/v3/resellers/{reseller_id}/managers

Arguments

Name

Parameter Type

Data type

Required/ Optional

Description

X-Api-TokenheaderstringRequiredAPI token of the Manager that performs the operation (see Viewing and updating manager's information)
Content-TypeheaderstringRequiredIndicates the media type (text/html or text/JSON) of the request that is sent to the server by the client (browser)
AcceptheaderstringRequiredInformation about data types that the client (browser) supports
reseller_idpathintegerRequiredID of the current Reseller or any of its downstream Resellers (see Viewing and updating reseller general information)
page[size]queryintegerOptionalPage navigation: number of elements per page. The default value is 50
page[number]queryintegerOptionalPage navigation: page number

Response model

Name

Data type

Description

dataarray of objectsResponse data


id

stringID of the Manager

typestringData type

attributesobjectInformation about the Manager


created_at

dateDate and time of the Manager creation


updated_at

dateDate and time when the Manager was updated


reseller_idintegerID of the Reseller


namestringManager's name


statusstring

Status of the Manager:

  • Active — access to the Operator Control Panel is allowed
  • Inactive — access to the Operator Control Panel is blocked


emailstringManager's email which is used as a login to the Operator Control Panel


rolestringManager's role (for the list of roles, see Managers' roles)


phonestring

Manager's phone number:

  • + < country code > < city code or network code > < phone number >
  • 00 < country code > < city code or network code > < phone number >


photostringLink to the file of the Manager's photo


manager_keystringUnique Manager's key


custom_attributesobject

Manager's Attributes (see Viewing the list of attributes)




['custom_attribute_key']stringManager's Attribute value for the specified Attribute key
linksobjectPage navigation links that use the defined page navigation parameters

selfstringCurrent page link

firststringFirst page link

prevstringPrevious page link

nextstringNext page link

laststringLast page link

Request example

GET /api/v3/resellers/1/managers?page[size]=2&page[number]=48
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Response example

{
    "data": [
        {
            "id": "431",
            "type": "managers",
            "attributes": {
                "created_at": "2021-01-05T05:28:48.804+03:00",
                "updated_at": "2021-01-05T06:23:10.815+03:00",
                "reseller_id": 1,
                "name": "Brendon Leannon",
                "status": "active",
                "email": "carter81@example.net",
                "role": "admin",
                "phone": "+375280000000",
                "photo": "/images/manager/431/manager.png",
				"manager_key": "",
                "custom_attributes": {
                    "manager_1c_identifier": ""
                }
            }
        },
        {
            "id": "432",
            "type": "managers",
            "attributes": {
                "created_at": "2021-01-08T21:33:32.789+03:00",
                "updated_at": "2021-01-08T21:34:29.005+03:00",
                "reseller_id": 1,
                "name": "Trycia Corwin",
                "status": "active",
                "email": "tryciacorwin71@example.net",
                "role": "sales",
                "phone": "+375270000000",
                "photo": "/images/manager/432/432.jpg",
				"manager_key": "",
                "custom_attributes": {
                    "manager_1c_identifier": "20"
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/managers?page%5Bnumber%5D=48&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/managers?page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/managers?page%5Bnumber%5D=47&page%5Bsize%5D=2",
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/1/managers?page%5Bnumber%5D=48&page%5Bsize%5D=2"
    }
}