plugin-support

GET /v1/plugin-support/connection

Read this site's own connection.

All plugin-support endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

This endpoint does not take an API key. It takes its own credential, issued to the plugin or service that calls it, as a bearer token; see the description above.

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/plugin-support/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 settings screen reads this to show the connection card. Authenticated by the connection token (pluginConnectionToken). A revoked token answers 401 with error.code = "connection_revoked", an unknown one "invalid_token" — the plugin shows the disconnected state with its reason and a reconnect button.

Response

NameTypeRequiredWhat it is
connection_idstringYes—
productstringYes—
site_urlstringYes—
statusstring<active, revoked>YesAlways active on getPluginSiteConnection — a revoked token is a 401.
scopesstring[]Yes—
created_atstringYes—
last_used_atobjectYes—

Errors this endpoint can return

401 · 429