partner
GET /v1/partner/customers/{externalId}/sites/{siteId}/resources
Read a customer's site's resource tier, boost level, usage and the boosts it can buy.
Authentication
Send an API key as a bearer token. The key must carry the partner.domains 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/partner/customers/{externalId}/sites/{siteId}/resources \
-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
What one of your customer's sites runs on (docs/866): the rung its plan gives (plan_tier), the boost level it holds, its current limits, what it USED in the last 24 hours (usage_24h, null when metrics are unavailable — never a zero), the boost that sets the level (held), and every boost level that would lift it higher (offers; empty at the top tier). Order an offer's code on createPartnerAddonOrder. Another customer's site is a 404. Requires partner.domains.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
externalId (path) | string | Yes | YOUR id for that customer — whatever your own system calls them. It is what makes linking idempotent, and it is scoped to your partner programme: another partner's id is a 404… |
siteId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
plan_tier | string | Yes | — |
tier | string | Yes | — |
boost_level | integer | Yes | — |
limits | object | Yes | — |
usage_24h | null | object | Yes | — |
held | null | object | Yes | — |
offers | object[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429