Skip to main content
GET
/
api
/
v1
/
outbound
/
batches
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.outbound.batches.list({
    page: 0,
    searchFields: [
      "last_updated_at",
    ],
    searchFieldValues: [
      "Some Object Name",
    ],
    startDatetime: "2023-01-01T00:00:00Z",
    endDatetime: "2024-01-01T00:00:00Z",
  });

  console.log(result);
}

run();
{
  "items": [
    {
      "batch_id": "<string>",
      "campaign_id": 123,
      "last_updated_by": "<string>",
      "expires_on": "2025-12-18T00:00:00Z",
      "paused": true,
      "status": "PENDING",
      "upload_filename": "LATE_PAYMENTS_20250401.csv",
      "created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2025-12-17T00:00:00Z",
      "deleted_reason": "User request",
      "last_updated_at": "2025-12-17T00:00:00Z",
      "error_message": "Invalid file format"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

​
Syllable-API-Key
string
header
required

Query Parameters

​
page
integer | null
default:0

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

Required range: x >= 0
Example:

0

​
limit
integer
default:25

The maximum number of items to return

Required range: x >= 0
Example:

25

​
search_fields
enum<string>[]

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

Available options:
batch_id,
campaign_id,
status,
expires_on,
last_updated_at
Example:

"name"

​
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

Example:

"Some Object Name"

​
order_by
enum<string> | null

The field whose value should be used to order the results

Available options:
batch_id,
campaign_id,
status,
expires_on,
last_updated_at
Example:

"name"

​
order_by_direction
enum<string> | null

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

Available options:
asc,
desc
​
fields
enum<string>[] | null

The fields to include in the response

Available options:
batch_id,
campaign_id,
status,
expires_on,
last_updated_at
​
start_datetime
string | null

The start datetime for filtering results

Example:

"2023-01-01T00:00:00Z"

​
end_datetime
string | null

The end datetime for filtering results

Example:

"2024-01-01T00:00:00Z"

Response

Successful Response

​
items
CommunicationBatch · object[]
required

List of items returned from the query

​
page
integer
required

The page number of the results (0-based)

Example:

0

​
page_size
integer
required

The number of items returned per page

Example:

25

​
total_pages
integer | null

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

Example:

4

​
total_count
integer | null

The total number of items returned from the query

Example:

100