Pular para o conteúdo principal
GET
/
v1
/
connections
/
{id}
Buscar conexão por ID
curl --request GET \
  --url https://api.liderhub.ai/v1/connections/{id} \
  --header 'x-company-key: <api-key>'
{
  "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)

Parâmetros de caminho

​
id
string
obrigatório

UUID da conexão

Resposta

Conexão retornada com sucesso

​
id
string<uuid>
obrigatório

Connection unique identifier

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-111111111111"

​
connectionStatus
string
obrigatório

Connection status

Exemplo:

"connected"

​
integration
enum<string>
obrigatório

Normalized integration type

Opções disponíveis:
WHATSAPP-BUSINESS,
WHATSAPP-NON-OFFICIAL
Exemplo:

"WHATSAPP-BUSINESS"

​
number
object

WhatsApp phone number

Exemplo:

"+5511999999999"

​
agent
object

Default agent ID (Agent.id)

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-111111111111"

​
department
object

Department ID

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-111111111111"

​
status
object

Status label ID

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-111111111111"

Last modified on April 21, 2026