API ReferenceConnections
Get QR Code
Retrieve the QR code for linking a WhatsApp account to a connection.
GET /api/connections/{id}/qr
Returns the QR code as a base64-encoded PNG image. Scan this QR code with your WhatsApp mobile app to link the account to this connection.
The QR code is only available when the connection is in scan_qr status. If the worker pod is still booting, a 503 response will be returned -- poll this endpoint until the QR code becomes available.
Authentication
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer token. Format: Bearer <token> |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The unique identifier of the connection. |
Response
{
"value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}{
"statusCode": 401,
"message": "Unauthorized"
}{
"statusCode": 404,
"message": "Connection not found"
}{
"statusCode": 503,
"message": "Worker is booting, please retry in a few seconds"
}