GET/v1/template-library

List the template library of a product version

The ready-made designs PostBuddy publishes for the product specification version, with their categories and thumbnails (short-lived links). Create a template from one with `libraryDesignId`.

Scope templates.read

Query parameters

productSpecificationIdstringrequiredmin length 1

Returns

2 fields of the 200 answer

categoriesarray of objectsrequired

3 fields

idstringrequired

namestringrequired

nameNlstring or nullrequired

designsarray of objectsrequired

7 fields

idstringrequired

namestringrequired

nameNlstring or nullrequired

descriptionstring or nullrequired

descriptionNlstring or nullrequired

categoryIdsarray of stringrequired

thumbnailsarray of objectsrequired

2 fields

sidestringrequired

urlstringrequired

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.templateLibrary.list({ query: { productSpecificationId: 'psp_01J9Y2K8QF4T6W8Z0B2D4F6H8K', }, });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.template_library.list(query={ "productSpecificationId": "psp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", })

{ "categories": [ { "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "nameNl": "Example" } ], "designs": [ { "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "nameNl": "Example", "description": "Welcome card for new customers", "descriptionNl": "Example", "categoryIds": [ "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K" ], "thumbnails": [ { "side": "Example", "url": "https://example.com/r/Fq3ZtR8w" } ] } ] }

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