GET/v1/assets

List image assets

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, name. Default -createdAt.

includeenum

include=total adds totalCount.

total

filter[name]string

filter[name][contains]string

filter[format]enum

jpegpng

filter[format][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

Returns

4 fields of the 200 answer

dataarray of objectsrequired

10 fields

idstringrequired

namestringrequired

formatenumrequired

jpegpng

widthPxintegerrequired

heightPxintegerrequired

hasAlphabooleanrequired

colourProfilestringrequired

sizeBytesintegerrequired

urlsobjectrequired

2 fields

masterstringrequired

thumbstringrequired

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

{ "data": [ { "id": "ast_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "format": "jpeg", "widthPx": 1, "heightPx": 1, "hasAlpha": false, "colourProfile": "Example", "sizeBytes": 1, "urls": { "master": "https://example.com/r/Fq3ZtR8w", "thumb": "https://example.com/r/Fq3ZtR8w" }, "createdAt": "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" } ] }