Retrieve a list of Manager objects.

Parameter

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

📘
This method accepts application/json

Parameter	Example	Required	Description	Parameter type
since	email	Optional	Email 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/v5/managers?limit=10&since=email

Response

Returns a list of Manager objects.

{
  "next": "string",
  "managers": [
    {
      "id": "string",
      "channelId": "string",
      "accountId": "string",
      "name": "string",
      "description": "string",
      "showDescriptionToFront": true,
      "nameDescI18nMap": {
        "additionalProp1": {
          "name": "string",
          "description": "string"
        },
        "additionalProp2": {
          "name": "string",
          "description": "string"
        },
        "additionalProp3": {
          "name": "string",
          "description": "string"
        }
      },
      "profile": {
        "name": "string",
        "empty": true,
        "email": "string",
        "avatarUrl": "string",
        "mobileNumber": "string",
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      },
      "email": "string",
      "showEmailToFront": true,
      "mobileNumber": "string",
      "showMobileNumberToFront": true,
      "role": "owner",
      "removed": true,
      "createdAt": 1656032151480,
      "displayAsChannel": true,
      "defaultGroupWatch": "all",
      "defaultDirectChatWatch": "all",
      "defaultUserChatWatch": "all",
      "chatAlertSound": "none",
      "showPrivateMessagePreview": true,
      "operatorScore": 0,
      "touchScore": 0,
      "avatar": {
        "bucket": "string",
        "key": "string",
        "width": 0,
        "height": 0
      },
      "operatorEmailReminder": true,
      "operator": true,
      "operatorScheduling": true,
      "operatorTimeRanges": {
        "timeRanges": [
          {
            "dayOfWeeks": [
              "mon"
            ],
            "from": 0,
            "to": 0
          }
        ]
      },
      "defaultAllMentionImportant": true,
      "userMessageImportant": true,
      "autoAssignCapacity": 0,
      "statusEmoji": "string",
      "statusText": "string",
      "statusClearAt": 1656032151487,
      "doNotDisturbClearAt": 1656032151487,
      "doNotDisturb": true,
      "avatarUrl": "string",
      "managerId": "string",
      "emailForFront": "string",
      "mobileNumberForFront": "string"
    }
  ],
  "onlines": [
    {
      "channelId": "string",
      "personType": "string",
      "personId": "string",
      "id": "string"
    }
  ]
}

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.