List of Managers

Retrieve a list of Manager objects.

Parameter

Accessible via URL https://api.channel.io/open/v3/managers and HTTP GET

📘

This method accepts application/json

Parameter

Example

Required

Description

Parameter type

since

username

Optional

Username of the first manager to be retrieved

Query

limit

25

Optional

Restrict the maximum number of messages to be retrieved

Query

Example

GET https://api.channel.io/open/v3/managers?limit=10&since=username

Response

Returns a list of Manager objects.

{
  "next": "String",
  "managers": [
    {
      "id": "String",
      "channelId": "String",
      "accountId": "String",
      "username": "String",
      "name": "String",
      "email": "String",
      "language": "String",
      "role": "String",
      "removed": Boolean,
      "createdAt": 1456287395182,
      "defaultWatch": "String",
      "operator": Boolean,
      "operatorScore": 0,
      "watchOpenUserChatViaEmail": Boolean,
      "watchOpenUserChatViaMobile": Boolean,
      "avatarUrl": "String",
      "systemLanguage": "String"
    }
  ],
  "onlines": [
    {
      "id": "String",
      "channelId": "String",
      "personType": "manager",
      "personId": "String",
      "createdAt": 1584783176266,
      "updatedAt": 1584783176266
    }
  ]
}

Implementation Notes

The number of managers retrieved in this endpoint is restricted by the limit query parameter, and is capped to values in the closed interval [1, 500].

Pagination is supported through the since query parameter along with the next value contained in the root object of the JSON response. Successive queries to this endpoint using the previous next value as the since parameter will ultimately retrieve all managers.

The since parameter can be left empty to start the list.