Retrieve a list of Plugin objects.

Parameter

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

📘
This method accepts application/json

Parameter	Example	Required	Description	Parameter type
since	1624422349278	Optional	Unix timestamp value of the first plugin to be retrieved in ascending order	Query
limit	25	Optional	Restrict the maximum number of plugins to be retrieved - min : 1 - max : 500 - default : 25	Query

Example

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

Response

Returns a set of Plugin object.

{
  "next": 1656032150048,
  "plugins": [
    {
      "id": "string",
      "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "channelId": "string",
      "state": "waiting",
      "name": "string",
      "createdAt": 1656032150208,
      "labelButton": true,
      "labelButtonText": "string",
      "labelButtonTextI18nMap": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "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,
      "mobileBubblePosition": "top",
      "accessSecret": "string",
      "urlWhitelist": [
        "string"
      ],
      "runRate": 0,
      "facebookPixelId": "string",
      "deskImageUrl": "string",
      "mobileImageUrl": "string",
      "validLabelButtonText": true,
      "validLabelButtonTextI18nMap": true
    }
  ]
}

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.