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

# Preview recipient count for a broadcast filter

> Live count + first 5 contact names for the given filter, without creating anything. Same filter precedence as POST /broadcasts/ (list_id > segment_id > filter_tags/filter_conv_status).



## OpenAPI

````yaml /openapi.json get /api/v1/broadcasts/preview/
openapi: 3.0.3
info:
  title: ChatBridge Public API
  version: 1.0.0
  description: >-
    Customer-facing REST API for ChatBridge — contacts, conversations, messages,
    templates, team, catalogue, tickets, and WhatsApp Flows. Authenticate with a
    workspace API key: `Authorization: Bearer cb_...`. See
    https://github.com/algosmiths/whatschat/blob/main/public_api.md for the full
    scope/versioning reference.
servers:
  - url: https://api.algosmiths.com
    description: Production
security: []
paths:
  /api/v1/broadcasts/preview/:
    get:
      tags:
        - Broadcasts
      summary: Preview recipient count for a broadcast filter
      description: >-
        Live count + first 5 contact names for the given filter, without
        creating anything. Same filter precedence as POST /broadcasts/ (list_id
        > segment_id > filter_tags/filter_conv_status).
      operationId: broadcasts_preview_retrieve
      parameters:
        - in: query
          name: segment_id
          schema:
            type: integer
        - in: query
          name: list_id
          schema:
            type: integer
        - in: query
          name: filter_tags
          schema:
            type: string
          description: Comma-separated
        - in: query
          name: filter_conv_status
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized — missing or invalid API key
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden — insufficient scope (requires broadcast.view)
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Too Many Requests — rate limit exceeded (60 requests/minute per key)
      security:
        - ApiKeyAuth: []
        - tokenAuth: []
        - CookieAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: cb_...
      description: >-
        Workspace API key, e.g. `Authorization: Bearer cb_live_...`. Create one
        in Settings → API Keys. See public_api.md § 3 for scopes.
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
    CookieAuth:
      type: apiKey
      in: cookie
      name: token
      description: Dashboard session cookie — internal use only, not the public contract.

````