GET/v1/events

Event feed

The organisation's events newest first in the webhook envelope (id, type, version, createdAt, organisationId, isTest, data) with a cursor, retained for 30 days; filter on type (comma separated) and a period. For polling integrations that do not receive webhooks.

Scope items.read

Query parameters

typeany

fromdate-time

todate-time

limitintegermin 1max 200default 50

cursorstringmax length 200

Returns

2 fields of the 200 answer

dataarray of objectsrequired

7 fields

idstringrequired

typeenumrequired

item.createditem.needs_attentionitem.helditem.readyitem.pending_approvalitem.scheduleditem.in_productionitem.handed_to_carrieritem.completeditem.returneditem.not_sentitem.faileditem.cancelleditem.suppressedpostbatch.validatedpostbatch.approvedpostbatch.scheduledpostbatch.completedpostbatch.cancelledimport.completedimport.failedtemplate.publishedpreview.readyqr.scannedand 7 more

versionintegerrequired

createdAtdate-timerequired

organisationIdstringrequired

isTestbooleanrequired

dataobjectrequired

nextCursorstring or nullrequired

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

{ "data": [ { "id": "evt_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "type": "item.created", "version": 1, "createdAt": "2026-10-16T09:14:02.000Z", "organisationId": "org_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "isTest": false, "data": {} } ], "nextCursor": "Example" }

{ "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" } ] }