visibility

GET /v1/visibility/domain-options

The organisation's own domains, to pick one to watch.

All visibility endpoints

All developer docs

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/visibility/domain-options \
  -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

Domains this organisation already has with us that match q — registered with us, connected to us, or attached to a site we host (even when registered elsewhere) — for the watch-a-domain picker. A type-ahead page of at most 20; narrow it by typing. Any other domain can still be watched by typing it in full. watched marks the ones already on the watch-list.

Parameters

NameTypeRequiredWhat it is
q (query)stringNo

Response

NameTypeRequiredWhat it is
optionsobject[]Yes

Errors this endpoint can return

401 · 403 · 422