Get manager

The Get manager method returns manager's details for the current reseller or any of its downstream resellers.

An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information

The manager's API token specified in an API request determines the current reseller and downstream resellers accessible within a method.

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

Arguments

Name

Parameter Type

Data type

Required/ Optional

Description

X-Api-TokenheaderstringRequiredAPI token of a manager that performs the operation (see Viewing and updating manager's information)
Content-TypeheaderstringRequiredMedia type of the request. Specify the following: application/vnd.api+json
AcceptheaderstringRequired

Supported media types of the answer. Specify the following: application/vnd.api+json

base_urlpathstringRequiredActivePlatform URL
reseller_idpathintegerRequiredID of the current reseller or any of its downstream resellers (see Viewing and updating reseller general information)
manager_idpathintegerRequiredID of the manager

Response model

Name

Data type

Description

dataarrayResponse data


id

integerID of the manager

typestringData type

attributesintegerInformation 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 manager's 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_keystring

Unique manager's key

This key allows linking an account to a manager (see Viewing and updating account's details) automatically when a customer orders a new service via Customer Store with a special URL parameter (see Buy-link template for ordering a service via Storefront). The key can include uppercase and lowercase characters, numbers, underscore, dot, and dash. The key is case-sensitive, so it is important to specify it in a buy-link exactly as on the manager information page. For example, carter81 and Carter81 are different keys, and they will not work together for the same manager.



custom_attributesobject

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




['custom_attribute_key']stringManager's attribute value for the specified attribute key

Request example

GET /api/v3/resellers/1/managers/431
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": "+375290000000",
            "photo": "/images/manager/431/manager.png",
			"manager_key": "",
            "custom_attributes": {
                "manager_1c_identifier": "20"
            }
        }
    }
}