---
title: "List your WhatsApp numbers"
method: GET
path: "/v1/whatsapp/numbers"
tags: ["WhatsApp"]
---

# List your WhatsApp numbers

`GET /v1/whatsapp/numbers`

## Request

- Base URL: `https://api.pyai.com`
- URL: `https://api.pyai.com/v1/whatsapp/numbers`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

WhatsApp Business numbers registered to your org, newest first. Active only unless `include_released=true`. Requires the `telephony:manage` scope.

## Query parameters

- `include_released` boolean

## Response `200`

Your WhatsApp numbers

- object
  - `object` string
  - `data` WhatsAppNumber[]
    - `object` string
    - `id` string
    - `waba_id` string: WhatsApp Business Account id.
    - `phone_number_id` string: Meta's id for the business number (what the webhook carries).
    - `phone_number` string: E.164.
    - `app_id` string, nullable
    - `agent_id` string, nullable: Agent that answers inbound WhatsApp calls.
    - `calling_enabled` boolean
    - `calling_settings` object: Last calling settings pushed to Meta.
    - `status` 'active' | 'released'
    - `created_at` integer: Unix ms.
    - `updated_at` integer: Unix ms.
    - `released_at` integer, nullable: Unix ms.

## Other responses

- `401`: Missing or invalid API key (`code: unauthorized`)
- `404`: WhatsApp calling is not enabled for this deployment.

---

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