hosting

GET /v1/site-blueprints

List your site blueprints.

All hosting endpoints

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

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/site-blueprints \
  -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

The management screen's data. A cheap database read, polled while a capture is in flight, so it never calls object storage — `has_screenshot` reports whether a picture exists and each tile asks for its own short-lived URL. Filter by `stack_type` to get exactly the blueprints that can be deployed onto a site of that stack; that is the same field the engine refuses a mismatch on, so a picker built on it cannot drift from the guard. Requires `sites.view`.

Parameters

NameTypeRequiredWhat it is
stack_type (query)StackTypeNoOnly blueprints captured from a site of this stack. The compatibility axis — a WordPress blueprint can only be deployed onto WordPress.
cursor (query)stringNoOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNoMaximum items to return (page size).
ordering (query)stringNoSort key, optionally `-`-prefixed for descending. One of `created` or `name`; defaults to `-created` (newest first). An unrecognised key is a `422`, never a silent fall back to…

Response

NameTypeRequiredWhat it is
dataSiteBlueprint[]Yes
pagePageMetaYes

Errors this endpoint can return

401 · 403 · 429