pbs-library

GET `/v1/pbs-library/kits`

List the Page Builder Sandwich website kits.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/pbs-library/kits \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Every kit with its pages (titles only), palette and preview. Public: with no token every Pro kit is listed with locked: true (the free plugin shows it greyed out with a Go Pro upsell, feature pbs-r2); with a Pro licence session pro_unlocked is true and nothing is locked. Budget 600/hour per IP.

Parameters

Name	Type	Required	What it is
`tier (query)`	`string<free, pro>`	No	—
`locale (query)`	`string`	No	WordPress or platform locale (fr_FR, pt-BR); names, descriptions and page titles are served in it, English per string where no translation exists yet.

Response

Name	Type	Required	What it is
`pro_unlocked`	`boolean`	Yes	—
`locale`	`string`	Yes	The platform locale the catalogue is in.
`kits`	`PbsKitSummary[]`	Yes	—

Errors this endpoint can return

401 · 429

GET /v1/pbs-library/kits