seo-connect
GET /v1/seo-connection
Read this site's own Zinn® SEO connection.
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/seo-connection \
-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 plugin's Account screen reads this. A revoked token answers 401 with error.code = "connection_revoked", an unknown one "invalid_token", so the plugin can show the right reconnect screen.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id | string | Yes | — |
org_id | string | Yes | — |
site_url | string | Yes | — |
site_uuid | string | Yes | — |
status | string<active, revoked> | Yes | — |
scopes | string[] | Yes | — |
method | string<device, signup> | Yes | — |
token_hint | string | Yes | The first eight characters after zsc_. |
plugin_version | string | Yes | — |
created_at | string | Yes | — |
last_used_at | object | Yes | — |
revoked_at | object | Yes | — |
revoked_by | object | Yes | — |
org | SeoConnectionOrg | Yes | — |
Errors this endpoint can return
401 · 429