API referenceConnections

Get a connection

GET
/v2/connections/{id}

Authorization

ApiKey
headerAuthorizationBearer <token>

An API key from Developers → API keys: Authorization: Bearer gauge_live_… (or pulse_k_live_…).

Path Parameters

id*string

The connection id.

Formatuuid

Header Parameters

Gauge-Version?string

A dated version. Default 2026-10-21.

Response Body

The connection.

application/json
  1. response
id*string
Formatuuid
kind*string
displayName*string
status*string
createdAt*string
capabilities*
flags*
warning*|null
limits*
Example Request
curl -X GET 'https://app.gauge.chat/backend/v2/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "string",  "displayName": "string",  "status": "string",  "createdAt": "string",  "capabilities": {    "sendText": true,    "sendMedia": true,    "sendTemplates": true,    "sendInteractive": true,    "quotedReplies": true,    "startConversations": true,    "broadcast": true,    "delivery": "immediate"  },  "flags": {    "property1": true,    "property2": true  },  "warning": {    "code": "whatsapp_web_ban_risk",    "message": "string"  },  "limits": {    "sessionWindowHours": 0,    "templateRequiredOutsideWindow": true,    "sendCaps": {      "perMinute": 0,      "perDay": 0,      "warmupTier": 0    },    "maxMediaBytes": 0  }}