---
title: "List Outbound Communication Batches"
method: GET
path: "/api/v1/outbound/batches"
tags: ["outbound.batches"]
---

# List Outbound Communication Batches

`GET /api/v1/outbound/batches`

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` BatchProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'batch_id' | 'campaign_id' | 'status' | 'expires_on' | 'last_updated_at'
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` BatchProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseCommunicationBatch
  - `items` CommunicationBatch[], required — List of items returned from the query
    - `batch_id` string, required — Unique ID for conversation batch
    - `campaign_id` integer, required — Unique ID for campaign
    - `expires_on` string, date-time, nullable — Timestamp of batch expiration
    - `paused` boolean, nullable — Whether the batch is on HOLD. When on HOLD, no outreach will be made.
    - `call_rate` integer, nullable — Target number of outreach attempts per hour for this batch. When omitted, the batch inherits the campaign's hourly_rate.
    - `status` 'PENDING' | 'ACTIVE' | 'PAUSED' | 'FAILED' | 'CANCELED' | 'EXPIRED' — Status of a communication batch.
    - `upload_filename` string, nullable — Name of file used to create batch
    - `dispatch_id` string, nullable — A unique identifier for dipatched job
    - `created_at` string, date-time — Timestamp of batch creation
    - `deleted_at` string, date-time, nullable — Timestamp of batch deletion
    - `deleted_reason` string, nullable — Reason for batch deletion
    - `last_updated_at` string, date-time, nullable — Timestamp of last change to batch
    - `last_updated_by` string, required — Email of user who last updated campaign
    - `error_message` string, nullable — Error message if batch upload failed
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/revisions/534f1f22c775/schema)