GET
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.outbound.batches.get_by_id(batch_id="<id>")

    # Handle response
    print(res)
{
  "batch_id": "20250530.9",
  "campaign_id": 1,
  "expires_on": "2025-05-31T00:00:00Z",
  "paused": true,
  "status": "PENDING",
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "created_at": "2025-05-30T00:00:00Z",
  "deleted_at": "2025-05-30T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2025-05-30T00:00:00Z",
  "last_updated_by": "user@email.com",
  "error_message": "Invalid file format",
  "status_counts": {
    "CANCELED": 7,
    "CONNECTED": 100,
    "DUPLICATE": 5,
    "FAILED": 10,
    "INITIATED": 20,
    "PENDING": 10
  }
}

Authorizations

Syllable-API-Key
string
header
required

Path Parameters

batch_id
string
required

Response

200
application/json

Successful Response

The response is of type object.