---
title: "List batches for a broadcast flow"
method: GET
path: "/broadcastFlows/{broadcastFlowId}/batches"
tags: ["broadcastFlows"]
---

# List batches for a broadcast flow

`GET /broadcastFlows/{broadcastFlowId}/batches`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/broadcastFlows/{broadcastFlowId}/batches`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/broadcastFlows/:broadcastFlowId/batches/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `broadcastFlowId` string, required

## Query parameters

- `page` integer
- `limit` integer
- `_populate` string
- `_select` string

## Response `200`

The batches were retrieved successfully

- object
  - `size` number: Number of batches returned
  - `page` number: Current page number
  - `response` BroadcastFlow[]
    - `_id` string: Luma's internal ID of an object.
    - `user` string: The ID of the root account user.
    - `deleted` 0 | 1: Flag for logical deletion where 1 means deleted.
    - `createdBy` string: The ID of the user who created this object.
    - `updatedBy` string: The ID of the user who updated this object.
    - `createdAt` string, date-time: The date/time when this object was created.
    - `updatedAt` string, date-time: The date/time when this object was updated.
    - `title` string
    - `type` 'scheduled' | 'uploaded' | 'sftp'
    - `parentBroadcastFlow` string: Luma's internal ID of an object.
    - `campaign` string: Luma's internal ID of an object.
    - `broadcastTemplate` string: Luma's internal ID of an object.
    - `patientMessageTemplate` string: Luma's internal ID of an object.
    - `review` object
      - `user` string: Luma's internal ID of an object.
      - `status` 'approved' | 'declined'
      - `declinedReason` string
    - `message` string
    - `messageOverrides` object[]
      - `text` string
      - `language` string
      - `channel` string
      - `subject` string
      - `patientMessageTemplate` string: Luma's internal ID of an object.
      - `secureChat` boolean
    - `sendAt` string, date-time
    - `sentAt` string, date-time
    - `configuration` object
      - `secureChat` boolean
      - `contactPreference` 'all-contacts' | 'primary-contact-only' | 'uploaded-contact-only'
      - `simulate` boolean
      - `shouldReprocessFilters` boolean
    - `processingStatus` 'pre-processing' | 'processing-upload' | 'rows-processed' | 'sending-messages' | 'success' | 'failure'
    - `upload` string: Luma's internal ID of an object.
    - `fileUpload` string: Luma's internal ID of an object.
    - `mapping` string: Luma's internal ID of an object.
    - `rowCount` integer
    - `stats` object
      - `totalMessagesSent` integer
      - `messagesSuccess` integer
      - `messagesFailed` integer
      - `messagesSkipped` integer

## Other responses

- `401`: Not authenticated
- `403`: Not authorized
- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)