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-Token | header | string | Required | API token of the Manager that performs the operation (see Viewing and updating manager's information) |
Content-Type | header | string | Required | Indicates the media type (text/html or text/JSON) of the request that is sent to the server by the client (browser) |
Accept | header | string | Required | Information about data types that the client (browser) supports |
reseller_id | path | integer | Required | ID of the current Reseller or any of its downstream Resellers (see Viewing and updating reseller general information) |
page[size] | query | integer | Optional | Page navigation: number of elements per page. The default value is 50 |
page[number] | query | integer | Optional | Page navigation: page number |
Response model
Name | Data type | Description | |||
---|---|---|---|---|---|
data | array of objects | Response data | |||
id | string | ID of the Manager | |||
type | string | Data type | |||
attributes | object | Information about the Manager | |||
created_at | date | Date and time of the Manager creation | |||
updated_at | date | Date and time when the Manager was updated | |||
reseller_id | integer | ID of the Reseller | |||
name | string | Manager's name | |||
status | string | Status of the Manager:
| |||
string | Manager's email which is used as a login to the Operator Control Panel | ||||
role | string | Manager's role (for the list of roles, see Managers' roles) | |||
phone | string | Manager's phone number:
| |||
photo | string | Link to the file of the Manager's photo | |||
manager_key | string | Unique Manager's key | |||
custom_attributes | object | Manager's Attributes (see Viewing the list of attributes) | |||
['custom_attribute_key'] | string | Manager's Attribute value for the specified Attribute key | |||
links | object | Page navigation links that use the defined page navigation parameters | |||
self | string | Current page link | |||
first | string | First page link | |||
prev | string | Previous page link | |||
next | string | Next page link | |||
last | string | Last 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"
}
}