List of Bots

Retrieve a list of Bots

Parameter

Accessible via URL https://api.channel.io/open/v4/bots and HTTP GET

Parameter

Example

Required

Description

Parameter Type

since

1624422339865

Optional

Unix timestamp value of the first bot to be retrieved in descending order

Query

limit

25

Optional

Maximum number of bots to be retrieved

  • min : 1
  • max : 500
  • default : 25

Query

Example

GET http://api.channel.io/open/v4/bots?since=1624422339865&limit=25

Response

Returns a list of Bots.

{
  "next": 1624422339857,
  "bots": [
    {
      "id": "string",
      "channelId": "string",
      "name": "string",
      "createdAt": 1624422361892,
      "avatar": {
        "bucket": "string",
        "key": "string",
        "width": 0,
        "height": 0
      },
      "color": "string",
      "avatarUrl": "string"
    }
  ]
}

Implementation note

The number of bots 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 bots. If the since parameter is left empty, the list retrieved will start with the bot of highest ID.