seo-connect
GET /v1/seo-connect/requests/{userCode}
Read a pending site connection request (the approval page).
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-connect/requests/{userCode} \
-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 dashboard's approval page (/connect/seo?code=) reads this after Keycloak signed the person in. approvable_org_ids are the organizations where they hold billing.payment.manage, the permission a site that spends the org's credits needs. An unknown, used or expired code is 404. 60 look-ups or answers per person per hour.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
userCode (path) | string | Yes | The code the plugin showed (BCDF-GHJK; case, spaces and the dash are ignored). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
user_code | string | Yes | — |
site_url | string | Yes | — |
site_host | string | Yes | — |
plugin_version | string | Yes | — |
method | string<device, signup> | Yes | — |
expires_in | integer | Yes | — |
suggested_org_id | object | Yes | — |
approvable_org_ids | string[] | Yes | — |
Errors this endpoint can return
401 · 404 · 429