> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useboom.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List numbers

> List the WhatsApp numbers connected to your organization, each with the WhatsApp account (WABA) it belongs to. Templates are per account: a template created on an account can be sent from every number on it and from no other. Use `whatsappAccount.id`, its `alias` (the name the team gave it, e.g. "Soporte") or any of its numbers to choose where to create a template.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/whatsapp-numbers
openapi: 3.1.0
info:
  title: Boom API
  version: 1.0.0
  description: >-
    Boom's public REST API — one uniform surface over every platform capability.
    CDP: upsert people and custom objects, define object and relationship types,
    link and unlink relationships, and record behavioral events — one record per
    request or up to 1000 per request via the `/batch` endpoints. Segments: read
    (list, read, membership) and full authoring — discover the filterable
    catalog, validate a filter, create and update segments, preview match
    counts, and trigger evaluation. Initiatives: create and configure outreach
    initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel,
    archive), and read collected-data summaries. Participants: enroll people
    into an active initiative, track their status, read conversation
    transcripts, and stop outreach. Journeys: read-only access to always-on
    message flows and their metrics. WhatsApp templates: list your WhatsApp
    numbers and list, read, and create message templates. The same capabilities
    are exposed as MCP tools with identical schemas.
servers:
  - url: https://www.useboom.ai
    description: Production
  - url: https://dev.useboom.ai
    description: Development (sandbox — use a development organization API key)
security:
  - bearerAuth: []
paths:
  /api/v1/whatsapp-numbers:
    get:
      tags:
        - WhatsApp templates
      summary: List numbers
      description: >-
        List the WhatsApp numbers connected to your organization, each with the
        WhatsApp account (WABA) it belongs to. Templates are per account: a
        template created on an account can be sent from every number on it and
        from no other. Use `whatsappAccount.id`, its `alias` (the name the team
        gave it, e.g. "Soporte") or any of its numbers to choose where to create
        a template.
      operationId: whatsapp_numbers_list
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        phoneNumber:
                          type: string
                          description: E.164 format, e.g. +5215512345678.
                        displayName:
                          type: string
                        status:
                          type: string
                          description: ONLINE means ready to send and receive messages.
                        whatsappAccount:
                          anyOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  description: >-
                                    Meta's WhatsApp Business Account ID (WABA
                                    ID), as shown in Meta Business Manager.
                                name:
                                  type: string
                                  description: >-
                                    The account's name: the team's alias when
                                    one is set, otherwise what its numbers are
                                    called on WhatsApp.
                                alias:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                  description: >-
                                    The name the team gave this account in Boom
                                    (e.g. "Soporte"), or null. Accepted anywhere
                                    a WABA ID is, such as `whatsappAccountId` on
                                    templates_create.
                                phoneNumbers:
                                  type: array
                                  items:
                                    type: string
                                  description: >-
                                    Every active number on this account. Each
                                    one can send all of its templates; no number
                                    outside it can.
                                approvedTemplateCount:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                  description: >-
                                    Approved templates on this account — all of
                                    them can be sent from this number.
                              required:
                                - id
                                - name
                                - alias
                                - phoneNumbers
                                - approvedTemplateCount
                              additionalProperties: false
                            - type: 'null'
                          description: >-
                            The WhatsApp account (WABA) this number belongs to,
                            with its other numbers. Null while the account is
                            still being set up.
                      required:
                        - phoneNumber
                        - displayName
                        - status
                        - whatsappAccount
                      additionalProperties: false
                  next_cursor:
                    type: 'null'
                required:
                  - data
                  - next_cursor
                additionalProperties: false
        '400':
          description: Validation failed or the request cannot proceed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '404':
          description: The resource does not exist in this organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '409':
          description: >-
            Conflicts with the current state (duplicates, wrong lifecycle
            state).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '422':
          description: The request is well-formed but semantically invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '429':
          description: Rate limit exceeded — retry after `Retry-After`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '503':
          description: Transient error — retry with a narrower request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Organization API key, sent as `Authorization: Bearer boom_org_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.