GET/v1/postflows

List Postflows

Cursor paged (API-005) with held, ready, pending approval and needs attention counts; archived Postflows only with filter[status].

Scope postflows.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 -updatedAt.

includeenum

include=total adds totalCount.

total

filter[status]enum

Without this filter ARCHIVED Postflows are hidden

ACTIVEPAUSEDARCHIVED

filter[status][in]string

Comma separated values

filter[templateId]string

filter[templateId][in]string

Comma separated values

filter[name]string

filter[name][contains]string

filter[dispatchStrategy]enum

IMMEDIATESEND_DATEMIN_COUNT_MAX_WAIT

filter[dispatchStrategy][in]string

Comma separated values

Returns

4 fields of the 200 answer

dataarray of objectsrequired

17 fields

idstringrequired

namestringrequired

descriptionstring or nullrequired

statusenumrequired

ACTIVEPAUSEDARCHIVED

templateIdstringrequired

versionPolicyenumrequired

LATEST_PUBLISHEDPINNED

pinnedVersionIdstring or nullrequired

productIdstringrequired

productSpecificationIdstringrequired

finishstringrequired

destinationstringrequired

dispatchobjectrequired

4 fields

strategyenumrequired

IMMEDIATESEND_DATEMIN_COUNT_MAX_WAIT

minCountinteger or nullrequired

maxWaitDaysinteger or nullrequired

strictMinimumbooleanrequired

requiresApprovalboolean or nullrequired

advertisingCategorystring or nullrequired

createdAtdate-timerequired

updatedAtdate-timerequired

countsobjectrequired

4 fields

heldintegerrequired

readyintegerrequired

pendingApprovalintegerrequired

needsAttentionintegerrequired

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.postflows.list({ query: { limit: 20, }, });

{ "data": [ { "id": "pf_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "description": "Welcome card for new customers", "status": "ACTIVE", "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "versionPolicy": "LATEST_PUBLISHED", "pinnedVersionId": "tv_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "productId": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "productSpecificationId": "psp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk", "destination": "Example", "dispatch": { "strategy": "IMMEDIATE", "minCount": 3, "maxWaitDays": 1, "strictMinimum": false }, "requiresApproval": false, "advertisingCategory": "Example", "createdAt": "2026-10-16T09:14:02.000Z", "updatedAt": "2026-10-16T09:14:02.000Z", "counts": { "held": 1, "ready": 1, "pendingApproval": 1, "needsAttention": 1 } } ], "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" } ] }