GET/v1/templates

List templates

Cursor paged (API-005). Without filter[status] only ACTIVE templates are listed; use filter[folderId][null]=true for the root folder.

Scope templates.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[folderId]string

Folder id; filter[folderId][null]=true for the root

filter[folderId][null]boolean

filter[productId]string

filter[productId][in]string

Comma separated values

filter[name]string

filter[name][contains]string

filter[status]enum

Without this filter only ACTIVE templates are listed

ACTIVEARCHIVED

filter[status][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[updatedAt][gte]date-time

filter[updatedAt][gt]date-time

filter[updatedAt][lte]date-time

filter[updatedAt][lt]date-time

Returns

4 fields of the 200 answer

dataarray of objectsrequired

10 fields

idstringrequired

namestringrequired

folderIdstring or nullrequired

productIdstringrequired

productSpecificationIdstringrequired

draftobjectrequired

3 fields

revisionintegerrequired

updatedAtdate-timerequired

updatedByIdstring or nullrequired

latestVersionobject or nullrequired

6 fields

idstringrequired

numberintegerrequired

publishedAtdate-timerequired

publishedByTypeenumrequired

USERAPI_KEY

publishedByIdstringrequired

staticLayerStatusenumrequired

PENDINGREADYFAILED

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

{ "data": [ { "id": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "folderId": "tf_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "productId": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "productSpecificationId": "psp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "draft": { "revision": 1, "updatedAt": "2026-10-16T09:14:02.000Z", "updatedById": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K" }, "latestVersion": { "id": "tv_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "number": 1, "publishedAt": "2026-10-16T09:14:02.000Z", "publishedByType": "USER", "publishedById": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "staticLayerStatus": "READY" }, "archivedAt": "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" } ] }