GET `/v1/ai/site-agent/preferences`

What this customer lets the AI do to their sites without asking.

Authentication

Send an API key as a bearer token. The key must carry the sites.view 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/ai/site-agent/preferences \
  -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

One row per fix the AI knows how to apply, carrying **three** values and not one: what the customer asked for (`requested`), what will actually happen (`effective`), and the highest mode the platform currently permits (`ceiling`). They differ when a customer has chosen more autonomy than a fix has earned. A response carrying only `effective` would misreport the customer's own setting back to them — they chose "just fix it", the page shows "ask me first", and it looks as though their click did not register. `clamped` is true in exactly that case and `reason` says why in words a customer can read. The ceiling is the platform's, not the customer's: a brand-new fix nobody has watched work cannot be set to unattended by anybody. Requires `sites.view`.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`Uuid`	No	Which organization this is about. Required when the caller belongs to more than one; a caller in exactly one may omit it.

Response

Name	Type	Required	What it is
`preferences`	`AiSiteAgentPreference[]`	Yes	—
`modes`	`object[]`	Yes	The available modes in increasing order of autonomy.

Errors this endpoint can return

401 · 403 · 422 · 429