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

# List broadcasts

> Retrieves a paginated list of sent broadcasts with summary statistics.



## OpenAPI

````yaml /openapi.json get /broadcasts
openapi: 3.1.0
info:
  description: Helo API
  version: 1.0.0-beta.1
  title: Helo API
servers:
  - url: https://api.helohq.com
security: []
tags:
  - name: Activity
    description: >-
      Track and retrieve message activity, including messages, delivery and
      engagement events.
  - name: Broadcasts
    description: Manage and track broadcast email campaigns.
  - name: Channels
    description: Create and manage communication channels for organizing messages.
  - name: Domains
    description: Register, verify, and manage domains for email sending.
  - name: Sending
    description: Send transactional and broadcast emails.
  - name: Statistics
    description: Access activity statistics.
  - name: Webhooks
    description: Create and manage webhooks for event notifications.
paths:
  /broadcasts:
    get:
      tags:
        - Broadcasts
      summary: List broadcasts
      description: Retrieves a paginated list of sent broadcasts with summary statistics.
      operationId: Broadcasts_list
      parameters:
        - name: channelId
          in: query
          description: The channel to list broadcasts for.
          required: true
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          description: Filter by broadcast status.
          required: false
          schema:
            $ref: '#/components/schemas/BroadcastStatus'
        - name: subject
          in: query
          description: Filter by subject (partial match). Max 500 characters.
          required: false
          schema:
            type: string
        - name: limit
          in: query
          description: Results per page. Min 1, max 500.
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            format: int32
        - name: offset
          in: query
          description: Pagination offset.
          required: false
          schema:
            type: integer
            minimum: 0
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponseOfBroadcast'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          $ref: '#/components/responses/422'
        '500':
          $ref: '#/components/responses/500'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: ruby
          source: |-
            Helo.configure do |config|
              config.api_key = ENV.fetch("HELO_API_KEY")
            end

            opts = {
              channel_id: "550e8400-e29b-41d4-a716-446655440000",
              subject: "example",
              limit: 10,
              offset: 10
            }
            Helo::Broadcasts.list(opts)
        - lang: javascript
          source: |-
            import Helo from "@helo-email/sdk";

            const apiKey = process.env.HELO_API_KEY;
            const helo = new Helo(apiKey);

            const result = await helo.broadcasts.list({
              channelId: "550e8400-e29b-41d4-a716-446655440000",
              status: Helo.BroadcastStatus.ACCEPTED,
              subject: "example",
              limit: 10,
              offset: 10,
            });
        - lang: go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"log\"\n\t\"os\"\n\n\t\"github.com/helo-email/helo-sdk-go\"\n)\n\nfunc main() {\n\tclient := helo.NewHelo(os.Getenv(\"HELO_API_KEY\"))\n\tctx := context.Background()\n\n\tparams := &helo.BroadcastsListParams{\n\t\tChannelID: \"550e8400-e29b-41d4-a716-446655440000\",\n\t\tStatus: helo.BroadcastStatusAccepted,\n\t\tSubject: \"example\",\n\t\tLimit: 10,\n\t\tOffset: 10,\n\t}\n\tresult, err := client.Broadcasts.List(ctx, params)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t_ = result\n}"
        - lang: csharp
          source: >-
            using HeloEmail.Sdk.Broadcasts;


            var broadcasts = await helo.Broadcasts.List("channel-id", status:
            BroadcastStatus.Completed);
        - lang: python
          source: |-
            import sdk_helo_email as helo

            client = helo.Helo()  # reads HELO_API_KEY from the environment

            broadcasts = client.broadcasts.list(
                channel_id="channel-id",
                status=helo.BroadcastStatus.COMPLETED,
            )
components:
  schemas:
    BroadcastStatus:
      enum:
        - accepted
        - processing
        - completed
        - canceled
      description: >-
        Current processing state of a broadcast. `accepted` — queued, waiting
        for the channel to become available. `processing` — actively sending
        messages. `completed` — all messages have been processed. `canceled` —
        stopped before completing.
    PaginatedResponseOfBroadcast:
      type: object
      properties:
        totalCount:
          type: integer
          format: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/BroadcastResponse'
      required:
        - totalCount
        - results
    BroadcastResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique broadcast identifier.
        createdAt:
          type: string
          format: date-time
          description: When the broadcast was submitted.
        status:
          $ref: '#/components/schemas/BroadcastStatus'
        subject:
          type: string
          description: Email subject line.
        completion:
          type: string
          description: Processing progress as a percentage (e.g. `"45%"`).
        messages:
          type: integer
          format: int32
          description: Total number of messages in the broadcast.
      required:
        - id
        - createdAt
        - status
        - subject
        - completion
        - messages
    ErrorResponse:
      description: Standard error response body.
      type: object
      properties:
        type:
          description: A URI reference identifying the problem type.
          type: string
        title:
          description: Short, human-readable summary of the problem.
          type: string
        instance:
          description: URI reference identifying the specific occurrence of the problem.
          type: string
        status:
          description: HTTP status code.
          type: integer
          format: int32
        code:
          description: Application-specific error code.
          type: string
        detail:
          description: Human-readable explanation of this specific occurrence.
          type: string
        requestId:
          description: Unique request ID, useful for support correlation.
          type: string
        errors:
          description: Field-level validation errors, keyed by field name.
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ValidationError'
    ValidationError:
      description: A single field validation error.
      required:
        - message
      type: object
      properties:
        message:
          description: Description of the validation failure.
          type: string
  responses:
    '401':
      description: Unauthorized
    '403':
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '422':
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '500':
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````