Skip to main content
GET
Get a batch with its live per-status rollup

Authorizations

Authorization
string
header
required

Dairo API key, e.g. dairo_test_... or dairo_live_...

Path Parameters

id
string
required

Response

Success

object
enum<string>
required
Available options:
letter_batch
id
string
required
status
string
required
total
integer
required
templateId
string | null
completed
integer

Member letters in a terminal state (delivered, undeliverable, canceled, failed).

statusCounts
object

Live count of member letters keyed by their letter status.

createdAt
string<date-time> | null
updatedAt
string<date-time> | null