public

GET /v1/public/footprint-checks

Whether the free public footprint check is switched on.

All public endpoints

All developer docs →

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

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

Anonymous. The free check is off by default and is turned on by the platform operator. This read always answers, in both states, so a page can decide whether to offer the check at all: while enabled is false the start and read operations below answer 404.

Response

NameTypeRequiredWhat it is
enabledbooleanYesWhether a free check can be started right now.
max_sitesintegerYesHow many sites one free check may name.

Errors this endpoint can return

429