Skip to content
Vendrix
Sign in

Connections

A connection is a WhatsApp number connected to your workspace. You get its Vendrix id, its status and its quality rating, never a Meta token.

These examples use a placeholder address. Your console shows the exact address of the API for your workspace.

GET /connections

Lists the WhatsApp connections of the workspace, newest first.

Required scope
connections.read
HTTP
Success: HTTP 200

Parameters

Parameters
NameDescription
limit

integer (1 to 100, default 20)
Query · Optional

Page size, 1 to 100. Default 20.
cursor

string
Query · Optional

The next_cursor of the previous page. See pagination.
status

string
Query · Optional

Only connections with this status: active, disconnected or pending.

Errors

Any authenticated endpoint can also return the authentication, scope and rate limit errors listed on the errors page.

Request

curl "https://api.vendrix.net/v1/connections?limit=20" \
  -H "Authorization: Bearer $VENDRIX_API_KEY"

Response

200 OK
{
  "data": [
    {
      "id": "6f0a3b1c-9d2e-4f50-8a71-3c5e7d9b1a24",
      "object": "connection",
      "provider": "whatsapp",
      "status": "active",
      "display_phone_number": "+237 6 70 00 00 00",
      "verified_name": "Boutique Awa",
      "quality_rating": "GREEN",
      "phone_number_id": "1234567890",
      "waba_id": "9876543210",
      "connected_at": "2026-09-30T12:00:00Z",
      "livemode": true
    }
  ],
  "next_cursor": null
}

GET /connections/{id}

Returns one connection, or 404 not_found if it does not exist or belongs to another workspace.

Required scope
connections.read
HTTP
Success: HTTP 200

Parameters

Parameters
NameDescription
id

string (UUID)
Path · Required

The id of the connection.

Errors

Any authenticated endpoint can also return the authentication, scope and rate limit errors listed on the errors page.

Request

curl "https://api.vendrix.net/v1/connections/6f0a3b1c-9d2e-4f50-8a71-3c5e7d9b1a24" \
  -H "Authorization: Bearer $VENDRIX_API_KEY"

Response

200 OK
{
  "id": "6f0a3b1c-9d2e-4f50-8a71-3c5e7d9b1a24",
  "object": "connection",
  "provider": "whatsapp",
  "status": "active",
  "display_phone_number": "+237 6 70 00 00 00",
  "verified_name": "Boutique Awa",
  "quality_rating": "GREEN",
  "phone_number_id": "1234567890",
  "waba_id": "9876543210",
  "connected_at": "2026-09-30T12:00:00Z",
  "livemode": true
}