Skip to main content
GET
Get a connect session

Authorizations

x-api-key
string
header
required

Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.

Keys are scoped. A key needs conversations:send to send, conversations:read to read threads and messages, templates:read to list templates, channels:read to list channels, and channels:manage to create connect sessions. A key missing the scope for an endpoint gets 403.

The CRM endpoints use the same resource:action form: leads:read, leads:create, leads:update, leads:delete, customers:read, customers:create, customers:update, customers:delete, customers:manage.

Several resources have no scope of their own and borrow one:

Grant only what the integration needs — a key that only sends notifications should hold conversations:send and nothing else.

X-Tenant-Id
string
header
required

Your workspace UUID. Required on every request in addition to x-api-key.

It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.

Path Parameters

id
string<uuid>
required

Response

The session.

id
string<uuid>
platform
enum<string>
Available options:
whatsapp,
whatsapp_qr,
facebook,
instagram,
tiktok
status
enum<string>

expired means the 30-minute link ran out before the person finished.

Available options:
pending,
connected,
cancelled,
expired
channelId
string<uuid> | null

Set once status is connected. Use it as channelId elsewhere in this API.

channelName
string | null
state
string | null

The state you sent, unchanged.

createdAt
string<date-time>
expiresAt
string<date-time>

When the link stops working.

completedAt
string<date-time> | null