GET /v1/plugins
GET
/v1/plugins
const url = 'https://seu-endereco-da-api/v1/plugins?onlyActive=example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://seu-endereco-da-api/v1/plugins?onlyActive=example' \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Gerenciar plugins (plugins:manage), ou Ler conversas (conversations:read).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”onlyActive
required
string
Responses
Seção intitulada “Responses”Media typeapplication/json
Array<object>
object
id
required
string
name
required
string
url
required
Https page loaded in the contact drawer, and the only origin the postMessage bridge talks to
string
isDefault
required
Opens by itself when the operator enters the plugins tab
boolean
active
required
boolean
allowDataTransfer
required
Whether the contact being served is sent to this plugin
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example generated
[ { "id": "example", "name": "example", "url": "example", "isDefault": true, "active": true, "allowDataTransfer": true, "createdAt": "2026-04-15T12:00:00Z", "updatedAt": "2026-04-15T12:00:00Z" }]