List of Plugins

Retrieve a list of Plugin objects.

Parameter

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

📘

This method accepts application/json

ParameterExampleRequiredDescriptionParameter type
since123124122OptionalEpoch time in microseconds of the first plugin to be retrievedQuery
limit25OptionalRestrict the maximum number of plugins to be retrieved
- min : 1
- max : 500
- default : 25
Query

Example

GET https://api.channel.io/open/v4/plugins?limit=25

Response

Returns a set of Plugin object.

{
  "next": 1624422349256,
  "plugins": [
    {
      "id": "string",
      "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "channelId": "string",
      "state": "waiting",
      "name": "string",
      "createdAt": 1624422363157,
      "color": "string",
      "textI18n": {
        "text": "string",
        "en": "string",
        "ja": "string",
        "ko": "string"
      },
      "botName": "string",
      "deskImage": {
        "bucket": "string",
        "key": "string",
        "width": 0,
        "height": 0
      },
      "deskMarginX": 0,
      "deskMarginY": 0,
      "deskPosition": "left",
      "mobileImage": {
        "bucket": "string",
        "key": "string",
        "width": 0,
        "height": 0
      },
      "mobileMarginX": 0,
      "mobileMarginY": 0,
      "mobilePosition": "left",
      "mobileHideButton": true,
      "accessSecret": "string",
      "welcomeI18n": {
        "text": "string",
        "en": "string",
        "ja": "string",
        "ko": "string"
      },
      "profileBot": true,
      "profileBotMessageI18n": {
        "text": "string",
        "en": "string",
        "ja": "string",
        "ko": "string"
      },
      "profileBotSchemaIds": [
        "string"
      ],
      "urlWhitelist": [
        "string"
      ],
      "runRate": 0,
      "facebookPixelId": "string",
      "textColor": "string",
      "deskImageUrl": "string",
      "mobileImageUrl": "string",
      "borderColor": "string",
      "gradientColor": "string"
    }
  ]
}

Implementation Notes

The number of plugins 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 plugins.

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