Connections

Buscar conexão por ID

Retorna os dados de uma conexão específica do workspace.

get/v1/connections/{id}

Request

  • Base URL
    https://api.liderhub.com.br
  • URL
    https://api.liderhub.com.br/v1/connections/{id}
  • Auth
    API key in header x-company-key

Path parameters

idstring required

UUID da conexão

Response

Conexão retornada com sucesso

idstring uuid required

Connection unique identifier

numberobject

WhatsApp phone number

connectionStatusstring required

Connection status

agentobject

Default agent ID (Agent.id)

departmentobject

Department ID

statusobject

Status label ID

integration'WHATSAPP-BUSINESS' | 'WHATSAPP-NON-OFFICIAL' required

Normalized integration type

Example response

{
  "id": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
  "connectionStatus": "connected",
  "integration": "WHATSAPP-BUSINESS"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.