Pular para o conteúdo principal
GET
/
v1
/
connections
Listar conexões WhatsApp
curl --request GET \
  --url https://api.liderhub.com.br/v1/connections \
  --header 'x-company-key: <api-key>'
{
  "connections": [
    {
      "id": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
      "number": "+5511999999999",
      "connectionStatus": "connected",
      "agent": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
      "department": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
      "status": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
      "integration": "WHATSAPP-BUSINESS"
    }
  ]
}

Autorizações

​
x-company-key
string
header
obrigatório

Chave de autenticação do workspace (gerada na plataforma Liderhub)

Resposta

Lista de conexões retornada com sucesso

​
connections
object[]
obrigatório
Exemplo:
[
  {
    "id": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    "number": "+5511999999999",
    "connectionStatus": "connected",
    "agent": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    "department": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    "status": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    "integration": "WHATSAPP-BUSINESS"
  }
]
Última modificação em 21 de abril de 2026