seo-connect
GET /v1/seo/agency-overview
Every connected Zinn® SEO site of the organization, with scores, alerts and spend.
Authentication
Send an API key as a bearer token. The endpoint checks billing.view; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/seo/agency-overview \
-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
Zinn® SEO stage E5 (zs-422). One row per connected site (cursor-paginated, newest first): latest rank, site-health, AI-visibility and backlink figures, the newest index-check batch, open SEO Guard incidents, work held for credit, this month's credit spend against the site's cap, and the report client whose domains cover it. summary covers the whole organization: balance, 30-day forecast, hold, totals. ⛔ Spend is read from the credit ledger (debits less refunds), never from an audit's charged_micros, which is 0 for credit-funded runs. Needs billing.view (org_id or X-Zinn-Org).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
cursor (query) | string | No | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | No | Maximum items to return (page size). |
org_id (query) | Uuid | No | — |
status (query) | string<active, revoked> | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AgencySeoSite[] | Yes | — |
page | PageMeta | Yes | — |
summary | object | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429