# List WhatsApp numbers (/docs/api-reference/whatsapp/listWhatsappNumbers)

> The WhatsApp numbers your API key can see, oldest first. Use it to find a number id, then pass that id to the other routes. Each number carries capabilities, which says what it can send. Archived numbers are left out.

> **Set up WhatsApp first.** Connect a WhatsApp number in the dashboard or with [Connect numbers](/docs/api-reference/whatsapp/importWhatsappNumbers). Included on every paid plan. [See plans](https://omnidim.io/pricing).

**GET** `/whatsapp/numbers`

The WhatsApp numbers your API key can see, oldest first. Use it to find
a number id, then pass that id to the other routes. Each number carries
`capabilities`, which says what it can send. Archived numbers are left
out.

```yaml
operationId: listWhatsappNumbers
parameters:
  - in: query
    name: limit
    schema:
      type: integer
      default: 20
      minimum: 1
      maximum: 100
    description: Rows per page.
  - in: query
    name: cursor
    schema:
      type: string
    description: >-
      The `next_cursor` from the previous page. Omit it on the first request and pass it back
      unchanged.
responses:
  '200':
    description: One page of numbers.
    content:
      application/json:
        schema:
          type: object
          properties:
            data:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                    example: 412
                  phone_number:
                    type: string
                    example: '+15551234567'
                  provider:
                    type: string
                    enum:
                      - meta
                      - twilio
                      - sensibot
                      - interakt
                    description: Who carries the number. `meta` is the WhatsApp Cloud API.
                  name:
                    type: string
                    nullable: true
                    description: The label you gave the number.
                  status:
                    type: string
                    enum:
                      - active
                      - restricted
                      - disconnected
                    description: |
                      `active` can send. `restricted` is limited by WhatsApp.
                      `disconnected` is missing its credentials, so it cannot send.
                  account_restriction:
                    type: string
                    nullable: true
                    description: WhatsApp's own restriction on the account, when there is one.
                  agent_id:
                    type: integer
                    nullable: true
                    description: The agent that answers this number, when one is attached.
                  quality_rating:
                    type: string
                    nullable: true
                    description: WhatsApp's quality rating. Meta numbers only.
                  messaging_limit:
                    type: string
                    nullable: true
                    description: How many customers you can start chats with in 24 hours. Meta numbers only.
                  capabilities:
                    type: object
                    description: What this number can send, and how its delivery status is learned.
                    properties:
                      types:
                        type: array
                        description: The message types this number can send. Always includes `text`.
                        items:
                          type: string
                          enum:
                            - text
                            - template
                            - image
                            - document
                      reply_to:
                        type: boolean
                        description: Supports quoted replies, read receipts, typing and reactions.
                      window_enforced:
                        type: boolean
                        description: >-
                          Free-form sends are refused outside the 24-hour window. True on WhatsApp
                          Cloud numbers.
                      delivery_status:
                        type: string
                        enum:
                          - push
                          - polled
                          - none
                        description: >-
                          How sent status is learned. `push` is a webhook, `polled` is a periodic
                          read, `none` is not at all.
                      template_sync:
                        type: boolean
                        description: Templates can be pulled from the provider with `syncWhatsappTemplates`.
            has_more:
              type: boolean
            next_cursor:
              type: string
              nullable: true
  '400':
    description: >-
      A bad parameter or body. `code` says which, such as `invalid_parameter`, `invalid_json`,
      `invalid_limit` or `invalid_cursor`.
    content:
      application/json:
        schema:
          type: object
          description: |
            The error envelope for every WhatsApp route. Some errors add keys:
            `fields` (the template parameters a send still needs), `ref` (a
            500's support reference) and `failed` (on `import_failed`).
          properties:
            error:
              type: string
              description: Machine-readable category, such as `invalid_request`.
            error_description:
              type: string
              description: Human-readable explanation.
            code:
              type: string
              description: Stable, specific reason, such as `window_closed`.
            request_id:
              type: string
              description: >-
                Correlates this response with the server log. Also sent as the `X-Request-Id`
                header.
            fields:
              type: array
              items:
                type: string
              description: >-
                On a template send missing parameters (`missing_fields`), the field keys you still
                need.
            ref:
              type: string
              description: On a `500`, the reference to quote to support.
            failed:
              type: array
              items:
                type: object
                properties:
                  phone_number_id:
                    type: string
                  message:
                    type: string
                    example: >-
                      This WhatsApp number is already connected to another account. Disconnect it
                      there first, then import it again. Contact support if you cannot access that
                      account.
              description: On `import_failed`, each number and why it could not be connected.
        example:
          error: invalid_request
          error_description: limit must be a whole number from 1 to 100.
          code: invalid_limit
          request_id: req_4a1c7d9e2f60
  '401':
    description: Missing or invalid API key.
    content:
      application/json:
        schema:
          type: object
          description: |
            The error envelope for every WhatsApp route. Some errors add keys:
            `fields` (the template parameters a send still needs), `ref` (a
            500's support reference) and `failed` (on `import_failed`).
          properties:
            error:
              type: string
              description: Machine-readable category, such as `invalid_request`.
            error_description:
              type: string
              description: Human-readable explanation.
            code:
              type: string
              description: Stable, specific reason, such as `window_closed`.
            request_id:
              type: string
              description: >-
                Correlates this response with the server log. Also sent as the `X-Request-Id`
                header.
            fields:
              type: array
              items:
                type: string
              description: >-
                On a template send missing parameters (`missing_fields`), the field keys you still
                need.
            ref:
              type: string
              description: On a `500`, the reference to quote to support.
            failed:
              type: array
              items:
                type: object
                properties:
                  phone_number_id:
                    type: string
                  message:
                    type: string
                    example: >-
                      This WhatsApp number is already connected to another account. Disconnect it
                      there first, then import it again. Contact support if you cannot access that
                      account.
              description: On `import_failed`, each number and why it could not be connected.
        example:
          error: unauthorized
          error_description: Missing or invalid API key
          code: invalid_api_key
          request_id: req_6e2b9d4f1a38
  '403':
    description: |
      `feature_not_enabled` when your plan or role cannot use WhatsApp,
      `permission_denied` when the key's user cannot make changes, or
      `service_unavailable` when the account is on hold.
    content:
      application/json:
        schema:
          type: object
          description: |
            The error envelope for every WhatsApp route. Some errors add keys:
            `fields` (the template parameters a send still needs), `ref` (a
            500's support reference) and `failed` (on `import_failed`).
          properties:
            error:
              type: string
              description: Machine-readable category, such as `invalid_request`.
            error_description:
              type: string
              description: Human-readable explanation.
            code:
              type: string
              description: Stable, specific reason, such as `window_closed`.
            request_id:
              type: string
              description: >-
                Correlates this response with the server log. Also sent as the `X-Request-Id`
                header.
            fields:
              type: array
              items:
                type: string
              description: >-
                On a template send missing parameters (`missing_fields`), the field keys you still
                need.
            ref:
              type: string
              description: On a `500`, the reference to quote to support.
            failed:
              type: array
              items:
                type: object
                properties:
                  phone_number_id:
                    type: string
                  message:
                    type: string
                    example: >-
                      This WhatsApp number is already connected to another account. Disconnect it
                      there first, then import it again. Contact support if you cannot access that
                      account.
              description: On `import_failed`, each number and why it could not be connected.
        example:
          error: forbidden
          error_description: You do not have permission to make changes to WhatsApp.
          code: permission_denied
          request_id: req_9f2c1a4b7d3e
  '500':
    description: Something went wrong on our side. Quote `ref` to support.
    content:
      application/json:
        schema:
          type: object
          description: |
            The error envelope for every WhatsApp route. Some errors add keys:
            `fields` (the template parameters a send still needs), `ref` (a
            500's support reference) and `failed` (on `import_failed`).
          properties:
            error:
              type: string
              description: Machine-readable category, such as `invalid_request`.
            error_description:
              type: string
              description: Human-readable explanation.
            code:
              type: string
              description: Stable, specific reason, such as `window_closed`.
            request_id:
              type: string
              description: >-
                Correlates this response with the server log. Also sent as the `X-Request-Id`
                header.
            fields:
              type: array
              items:
                type: string
              description: >-
                On a template send missing parameters (`missing_fields`), the field keys you still
                need.
            ref:
              type: string
              description: On a `500`, the reference to quote to support.
            failed:
              type: array
              items:
                type: object
                properties:
                  phone_number_id:
                    type: string
                  message:
                    type: string
                    example: >-
                      This WhatsApp number is already connected to another account. Disconnect it
                      there first, then import it again. Contact support if you cannot access that
                      account.
              description: On `import_failed`, each number and why it could not be connected.
        example:
          error: server_error
          error_description: >-
            Something went wrong on our side. Please try again shortly, or contact support with
            reference 9a1f3e8b02c4.
          ref: 9a1f3e8b02c4
          code: server_error
          request_id: req_9a1f3e8b02c4
```

**curl**

```bash
curl -X GET "https://omnidim.io/api/v1/whatsapp/numbers" \
  -H "Authorization: Bearer $OMNIDIM_API_KEY"
```