public
GET /v1/public/footprint-checks/{token}
Read a public footprint check back by its token.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
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/public/footprint-checks/{token}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
404 for a token that names nothing — and for every token while the free check is switched off (refusal.footprint.publicDisabled).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
token (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
token | string | Yes | Read the check back with this. |
state | string<running, done, failed> | Yes | — |
score | integer | No | 100 means nothing public ties the sites together. null until done. |
grade | string | No | A to E; empty until done. |
sites_count | integer | Yes | — |
reachable_count | integer | Yes | — |
risks | object | Yes | How many things to look at, by how strongly each ties the sites together. |
risk_count | integer | Yes | — |
good_count | integer | Yes | Things checked and found clear. |
sites | object[] | Yes | — |
started_at | string | Yes | — |
finished_at | string | No | — |
Errors this endpoint can return
404 · 429