WhatsApp Gateway
API referenceSessions

Get the current pairing QR code

GET
/api/v1/sessions/{session}/qr

Return the current pairing QR code for the session.

If a code is not ready yet, pairing starts and the route returns not_found (404) until one is available.

Requires manage capability. Response body is raw QR string.

Errors: not_found (404), unauthorized (401), forbidden (403).

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.

In: header

Path Parameters

session*string

Session ID within your organization. Unknown or cross-organization sessions return not_found (404).

Example"sess_01HZX8K3M9"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/sessions/sess_01HZX8K3M9/qr"
{  "code": "string",  "expiresAt": 0}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}