GET/v1/postbatches

List Postbatches

Cursor paged (API-005) with the counts per item status; filter on status, template, campaign, created date and a name search.

Scope items.read

Query parameters

limitintegermin 1max 200default 50

cursorstring

Opaque cursor from nextCursor of the previous page (same sort and filters).

sortstring

Comma separated, prefix - for descending; fields: createdAt, updatedAt, name. Default -createdAt.

includeenum

include=total adds totalCount.

total

filter[status]enum

DRAFTIMPORTINGVALIDATEDPENDING_APPROVALAPPROVEDSCHEDULED_FOR_RUNIN_PRODUCTIONCOMPLETEDCANCELLED

filter[status][in]string

Comma separated values

filter[status][ne]enum

DRAFTIMPORTINGVALIDATEDPENDING_APPROVALAPPROVEDSCHEDULED_FOR_RUNIN_PRODUCTIONCOMPLETEDCANCELLED

filter[templateId]string

filter[templateId][in]string

Comma separated values

filter[campaignId]string

filter[campaignId][in]string

Comma separated values

filter[createdAt][gte]date-time

filter[createdAt][gt]date-time

filter[createdAt][lte]date-time

filter[createdAt][lt]date-time

filter[search][contains]string

Returns

4 fields of the 200 answer

dataarray of objectsrequired

18 fields

idstringrequired

namestringrequired

campaignIdstring or nullrequired

advertisingCategorystring or nullrequired

statusenumrequired

DRAFTIMPORTINGVALIDATEDPENDING_APPROVALAPPROVEDSCHEDULED_FOR_RUNIN_PRODUCTIONCOMPLETEDCANCELLED

templateIdstringrequired

templateVersionIdstringrequired

productobjectrequired

4 fields

idstringrequired

specificationIdstringrequired

finishstringrequired

destinationstringrequired

countsobjectrequired

importIdstring or nullrequired

approvedAtdate-time or nullrequired

targetRunIdstring or nullrequired

priceSnapshotIdstring or nullrequired

itemCountAtApprovalinteger or nullrequired

cancelledAtdate-time or nullrequired

completedAtdate-time or nullrequired

createdAtdate-timerequired

updatedAtdate-timerequired

nextCursorstring or nullrequired

hasMorebooleanrequired

totalCountinteger

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.postbatches.list({ query: { limit: 20, }, });

{ "data": [ { "id": "pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "campaignId": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "advertisingCategory": "Example", "status": "COMPLETED", "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "templateVersionId": "tv_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "product": { "id": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "specificationId": "psp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk", "destination": "Example" }, "counts": { "key": 1 }, "importId": "ipt_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "approvedAt": "2026-10-16T09:14:02.000Z", "targetRunId": "run_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "priceSnapshotId": "ps_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "itemCountAtApproval": 3, "cancelledAt": "2026-10-16T09:14:02.000Z", "completedAt": "2026-10-16T09:14:02.000Z", "createdAt": "2026-10-16T09:14:02.000Z", "updatedAt": "2026-10-16T09:14:02.000Z" } ], "nextCursor": "Example", "hasMore": false, "totalCount": 3 }

{ "type": "https://docs.postbuddy.nl/errors/validation_failed", "title": "Validation failed", "status": 422, "code": "validation_failed", "detail": "Validation failed", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "errors": [ { "field": "recipient.postalCode", "code": "invalid_string", "message": "Invalid postal code" } ] }