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

# Get a broadcast

> Returns a broadcast with its live counters. `status` moves
`queued` to `sending` to `sent` (or `failed`), while
`delivered_count` and `read_count` keep climbing as WhatsApp reports
back.

Requires the `broadcasts:send` scope.




## OpenAPI

````yaml /openapi.yaml get /broadcasts/{id}
openapi: 3.1.0
info:
  title: Watx API
  version: '1'
  description: |
    The Watx public REST API. Send WhatsApp messages, manage contacts and
    segments, read conversations and messages, launch broadcasts, and register
    webhook endpoints.

    Every request authenticates with a workspace API key sent as a bearer
    token. A key acts on exactly one workspace and can only do what its scopes
    allow. Each operation below names the scope it requires.
  contact:
    name: Watx support
    email: support@watx.in
servers:
  - url: https://api.watx.in/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Account
    description: Check which workspace a key belongs to and what it can do.
  - name: Messages
    description: Send a WhatsApp message to a phone number.
  - name: Contacts
    description: Create, read, update and list contacts.
  - name: Conversations
    description: Read conversations and their messages.
  - name: Broadcasts
    description: Launch a template broadcast and follow its progress.
  - name: Segments
    description: Named audiences — static lists and saved filters.
  - name: Webhooks
    description: Register endpoints that receive events from your workspace.
paths:
  /broadcasts/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: The broadcast id.
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Broadcasts
      summary: Get a broadcast
      description: |
        Returns a broadcast with its live counters. `status` moves
        `queued` to `sending` to `sent` (or `failed`), while
        `delivered_count` and `read_count` keep climbing as WhatsApp reports
        back.

        Requires the `broadcasts:send` scope.
      operationId: getBroadcast
      responses:
        '200':
          description: The broadcast.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Broadcast'
              example:
                data:
                  id: 4f8e2c10-77b9-4d3a-9e12-5a6b7c8d9e0f
                  name: September offer
                  template_name: september_offer
                  template_language: en_US
                  status: sending
                  total_recipients: 2
                  sent_count: 2
                  delivered_count: 1
                  read_count: 0
                  replied_count: 0
                  failed_count: 0
                  created_at: '2026-09-15T06:41:02.000Z'
                  updated_at: '2026-09-15T06:41:20.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Broadcast:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
            - string
            - 'null'
        template_name:
          type:
            - string
            - 'null'
        template_language:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - draft
            - queued
            - scheduled
            - sending
            - sent
            - failed
        total_recipients:
          type:
            - integer
            - 'null'
        sent_count:
          type:
            - integer
            - 'null'
        delivered_count:
          type:
            - integer
            - 'null'
        read_count:
          type:
            - integer
            - 'null'
        replied_count:
          type:
            - integer
            - 'null'
        failed_count:
          type:
            - integer
            - 'null'
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    Error:
      type: object
      description: |
        Every failure uses this shape. Branch on `error.code`, which is stable;
        `error.message` is written for people and may be reworded.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: |
                One of `bad_request`, `invalid_request`, `unauthorized`,
                `forbidden`, `not_found`, `rate_limited`, `internal`, or a
                domain code such as `whatsapp_not_configured`, `meta_error`,
                `template_malformed`, `plan_limit_reached`,
                `subscription_lapsed`.
              example: bad_request
            message:
              type: string
              example: '''phone'' is required'
  responses:
    Unauthorized:
      description: |
        The key is missing, malformed, unknown, revoked or expired. All four
        answer the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Missing or invalid API key
    Forbidden:
      description: The key is valid but was not granted the scope this operation requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden
              message: This API key is missing the 'messages:send' scope
    NotFound:
      description: |
        No such resource in this workspace. A resource belonging to another
        workspace answers the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: Contact not found
    RateLimited:
      description: |
        More than 120 requests in a minute for this key. `Retry-After` says how
        many seconds to wait.
      headers:
        Retry-After:
          description: Seconds until the window resets.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests allowed per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in this window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time in seconds when the window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Rate limit exceeded for this API key
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: |
        Your workspace API key, created in **Settings → API keys**, sent as
        `Authorization: Bearer <key>`. New keys start with `watx_live_`; keys
        issued before the rename start with `converse360_live_` and still work.

````