---
title: "List connected numbers"
method: POST
path: "/whatsapp-client/list/"
tags: ["WhatsApp numbers"]
---

# List connected numbers

`POST /whatsapp-client/list/`

## Request

- Base URL: `https://wbiztool.com/api/v1`
- URL: `https://wbiztool.com/api/v1/whatsapp-client/list/`
- Auth: none required

The WhatsApp numbers (and Telegram accounts) of the workspace that are connected right now, with the IDs to pass as `whatsapp_client`. A non-POST request returns `{}`; an unexpected server problem an HTML 500 page. The JSON body is served with `Content-Type: text/html`; parse it as JSON whatever the header says.

## Request body

- Credentials: Your API credentials, sent in the request body (JSON or form fields) of every request that uses them. Both come from Settings → API keys in the dashboard. The API key decides which workspace the request acts on.
  - `client_id` integer, required: Your API Client ID from Settings → API keys.
  - `api_key` string, required: One of your API keys from the same page. Keep it secret.

## Response `200`

Connected numbers (`status: 1`), or `{"message": "Auth Error", "status": 0}`.

- union
  - ConnectedNumbers
    - `status` 1, required
    - `message` 'okay', required
    - `whatsapp_clients` object[], required
      - `id` integer: Same as `whatsapp_client_id`.
      - `whatsapp_client_id` integer
      - `whatsapp_client_number` string
      - `platform` 'whatsapp' | 'telegram'
      - `is_connected` boolean: Always `true`.
  - ApiError: A failed request. `status` is `0` and `message` says why. (`Account Disabled` has no `status` field.)
    - `status` 0
    - `message` string, required

## Other responses

- `400`: Invalid API key.
- `403`: `client_id` is not a whole number.
- `500`: HTML error page instead of JSON (see the operation description).

---

[API](https://skmtc.dev/wbiztool/apis/wbiztool-api.md) · [All operations](https://skmtc.dev/wbiztool/apis/wbiztool-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wbiztool/apis/wbiztool-api/revisions/bc7380bb5684?raw)