# List WhatsApp inboxes

> GET https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes

Group: WhatsApp. Page: https://www.nabrah.ai/en/docs/api-reference/whatsapp/list-whatsapp-inboxes

List the WhatsApp inboxes connected to the project, oldest first. Each inbox represents a connected WhatsApp number and includes its `id`, `inbox_type`, `project_id`, display `name`, `config`, `created_at`, and the agent answering on it. Use the returned `id` as the `inbox_id` for the other WhatsApp endpoints.

## Where inbox IDs come from

This is the canonical source for `inbox_id` values used by other WhatsApp endpoints.

- **inboxes[].id**: The UUID of each WhatsApp inbox. Pass it as `inbox_id` to the other WhatsApp endpoints, or as the `{inbox_id}` path parameter to GET full inbox details. Fields: `id`, `inbox_type`, `project_id`, `name`, `config`, `created_at`.
- **inboxes[].inbox_id**: A numeric id for the number. Conversations carry the same value in their `inbox_id` field, so you can tell which number a conversation came in on. Do not pass it as `inbox_id` to other endpoints. Fields: `inbox_id`.
- **Answering agent**: The agent auto-replying on the number, or null when none is assigned. Fields: `chatbot_agent_id`, `chatbot_agent_name`.
- **max_inboxes**: How many WhatsApp numbers the project may connect. Contact support to raise it. Fields: `max_inboxes`.
- **How the number was connected**: `config.connection_method` is `embedded_signup` for numbers connected through Meta sign-in in the app, and is absent for numbers connected with their credentials. Numbers connected through Meta sign-in also include `config.verified_name` and `config.name_status` (the display name and its review status). `config.meta_disconnected` is true when access to the number was removed in Meta; reconnect it from the app to keep its conversations and settings. Fields: `config.connection_method`, `config.verified_name`, `config.name_status`, `config.meta_disconnected`.

## Authorization

- `X-API-Key` (string, header, required): your workspace API key.

## Response

### 200 Successful Response

Content type: `application/json`

```json
{
  "inboxes": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "inbox_type": "whatsapp",
      "project_id": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "config": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "inbox_id": 0,
      "chatbot_agent_id": "00000000-0000-4000-8000-000000000000",
      "chatbot_agent_name": "string"
    }
  ],
  "max_inboxes": 0
}
```

## Request examples

### cURL

```bash
curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes' \
  --header 'X-API-Key: <your-api-key>'
```

### Python

```python
import requests

url = "https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes"
headers = {"X-API-Key": "<your-api-key>"}

response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes", {
  method: "GET",
  headers: { "X-API-Key": "<your-api-key>" },
});

const data = await response.json();
console.log(data);
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes", nil)
	req.Header.Set("X-API-Key", "<your-api-key>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}
```