GET/v1/products

List active products with their current specification

Scope templates.read

Returns

11 fields of the 200 answer

idstringrequired

keystringrequired

namestringrequired

descriptionstring or nullrequired

categoryenumrequired

POSTCARDGREETING_CARDLETTERSELF_MAILER

productGroupstringrequired

specificationobjectrequired

25 fields

idstringrequired

productIdstringrequired

versionintegerrequired

statusenumrequired

DRAFTPUBLISHEDRETIRED

trimWidthMmnumberrequired

trimHeightMmnumberrequired

bleedMmnumberrequired

safeZoneMmnumberrequired

orientationenumrequired

PORTRAITLANDSCAPE

sidesarray of stringrequired

paperstringrequired

allowedFinishesarray of stringrequired

envelopeobject or nullrequired

3 fields

typestringrequired

windowSidestring or nullrequired

windowobject or nullrequired

4 fields

xnumberrequired

ynumberrequired

widthnumberrequired

heightnumberrequired

addressZoneobjectrequired

6 fields

sidestringrequired

xnumberrequired

ynumberrequired

widthnumberrequired

heightnumberrequired

carrierRuleSetstringrequired

postageZoneobject or nullrequired

5 fields

sidestringrequired

xnumberrequired

ynumberrequired

widthnumberrequired

heightnumberrequired

allowedDestinationsarray of stringrequired

weightClassstringrequired

minImageDpiintegerrequired

carrierLeadTimeDaysintegerrequired

hasBaseTemplatebooleanrequired

baseVariablesarray of objectsrequired

9 fields

namestringrequired

typeenumrequired

textnumberdatebooleanimageUrlurl

requiredbooleanrequired

kindenum

customerfixed

valuestring

fallbackstring

maxLengthinteger

formatstring

descriptionstring

publishedAtdate-time or nullrequired

retiredAtdate-time or nullrequired

createdAtdate-timerequired

updatedAtdate-timerequired

finishesarray of stringrequired

destinationsarray of stringrequired

leadTimeDaysintegerrequired

carrierCodesarray of objectsrequired

3 fields

keystringrequired

labelstringrequired

symbologyenumrequired

textkixdatamatrixgs1datamatrixcode128

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

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

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/products \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.products.list();

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.products.list()

Response

[
  {
    "id": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
    "key": "first_name",
    "name": "Welcome card",
    "description": "Welcome card for new customers",
    "category": "POSTCARD",
    "productGroup": "Example",
    "specification": {
      "id": "psp_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
      "productId": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
      "version": 1,
      "status": "PUBLISHED",
      "trimWidthMm": 1,
      "trimHeightMm": 1,
      "bleedMm": 1,
      "safeZoneMm": 1,
      "orientation": "PORTRAIT",
      "sides": [
        "Example"
      ],
      "paper": "Example",
      "allowedFinishes": [
        "Example"
      ],
      "envelope": {
        "type": "item.completed",
        "windowSide": "Example",
        "window": {
          "x": 1,
          "y": 1,
          "width": 1,
          "height": 1
        }
      },
      "addressZone": {
        "side": "Example",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1,
        "carrierRuleSet": "Example"
      },
      "postageZone": {
        "side": "Example",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1
      },
      "allowedDestinations": [
        "Example"
      ],
      "weightClass": "Example",
      "minImageDpi": 1,
      "carrierLeadTimeDays": 1,
      "hasBaseTemplate": false,
      "baseVariables": [
        {
          "name": "Welcome card",
          "type": "text",
          "required": false,
          "kind": "customer",
          "value": "Example",
          "fallback": "Example",
          "maxLength": 1,
          "format": "2026-10-16T09:14:02.000Z",
          "description": "Welcome card for new customers"
        }
      ],
      "publishedAt": "2026-10-16T09:14:02.000Z",
      "retiredAt": "2026-10-16T09:14:02.000Z",
      "createdAt": "2026-10-16T09:14:02.000Z",
      "updatedAt": "2026-10-16T09:14:02.000Z"
    },
    "finishes": [
      "Example"
    ],
    "destinations": [
      "Example"
    ],
    "leadTimeDays": 1,
    "carrierCodes": [
      {
        "key": "first_name",
        "label": "First name",
        "symbology": "text"
      }
    ]
  }
]