surveys

GET /v1/feature-flags

Every feature flag that is ON for this person in this organisation.

All surveys endpoints

Authentication

Send an API key as a bearer token. The key must carry the org.read permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

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/feature-flags \
  -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

Evaluated by the engine rather than in the browser, so an ad-blocker cannot switch off whatever every flag gates, and so the product and the API cannot disagree about what a customer is entitled to see. A boolean flag answers `true`; an experiment answers its variant name. ⛔ `available: false` is NOT `flags: {}`. An empty map and "every flag is off" are the same value, and every consumer reads a missing key as off — so a rate-limited vendor would quietly switch off whatever every flag gates. The client keeps its last answer on `available: false`. Requires `org.read`.

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNo
distinct_id (query)stringNo

Response

NameTypeRequiredWhat it is
availablebooleanYes
reasonstring<, unconfigured, unreachable, refused, not_found, malformed>Yes
flagsobjectYes`true` for a boolean flag; the variant name for an experiment.

Errors this endpoint can return

401 · 403