seo-connect

GET /v1/seo-connections

The organization's connected Zinn® SEO sites.

All seo-connect endpoints

All developer docs →

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.

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-connections \
  -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

Newest first, cursor-paginated. Needs billing.view in the organization (org_id or X-Zinn-Org; omitted, the one org the caller holds it in).

Parameters

NameTypeRequiredWhat it is
cursor (query)stringNoOpaque cursor from a previous page's page.next_cursor.
limit (query)integerNoMaximum items to return (page size).
org_id (query)UuidNoThe organization.
status (query)string<active, revoked>NoOnly connections in this state.

Response

NameTypeRequiredWhat it is
dataSeoSiteConnection[]Yes—
pagePageMetaYes—

Errors this endpoint can return

401 · 403 · 422 · 429