Sign in

v64

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01176310978.7 KB
outbound.batches

List Outbound Communication Batches

get/api/v1/outbound/batches

Query parameters

pageinteger nullable

The page number from which to start (0-based)

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25

The maximum number of items to return

search_fieldsBatchProperties[]

String names of fields to search. Correspond by index to search field values

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

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

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'

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsBatchProperties[] nullable

The fields to include in the response

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z

The start datetime for filtering results

end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

The end datetime for filtering results

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "batch_id": "20260801.9",
      "campaign_id": 1,
      "expires_on": "2026-08-02T00:00:00Z",
      "paused": true,
      "upload_filename": "LATE_PAYMENTS_20250401.csv",
      "dispatch_id": "5ac42327fbd7e03b441650b79ae91ae1",
      "created_at": "2026-08-01T00:00:00Z",
      "deleted_at": "2026-08-01T00:00:00Z",
      "deleted_reason": "User request",
      "last_updated_at": "2026-08-01T00:00:00Z",
      "last_updated_by": "user@email.com",
      "error_message": "Invalid file format"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}