hosting
GET /v1/sites/{site_id}/translation/bundle/{locale}
One locale of a site's translated content, for the site itself to render.
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/sites/{site_id}/translation/bundle/{locale} \
-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 translated string this site has in `locale`, keyed by document. **This is the consumer end of the product**: the Zinn® Translate plugin on the customer's own WordPress site calls it, caches the payload, and swaps titles, bodies, excerpts and slugs at render time. **Last-good-while-stale, per string.** An entry is returned whenever its text is non-empty, whatever its status: a re-translation in flight must not blank a paragraph that is already live on someone's site. A string with no translation yet is **absent from the payload** rather than present and empty — the plugin then renders the customer's own words, and those two cases mean different things. Readable without good standing, deliberately: taking a live site's translated pages down over an unpaid invoice is a worse outcome than the invoice, and the customer never agreed to it. It does require a live subscription — a site that never bought this gets a `403`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
site_id (path) | Uuid | Yes | — |
locale (path) | LocaleCode | Yes | The locale to fetch (docs/28 registry code). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
locale | LocaleCode | Yes | BCP-47 / ISO locale code from the language registry (docs/28). |
documents | SiteTranslationDocument[] | Yes | — |
ready | integer | Yes | — |
total | integer | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422