visibility
GET /v1/visibility/plan
What visibility add-ons this organisation holds.
Authentication
Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.
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/plan \
-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
Which visibility products the organisation has (ai_visibility, reputation, onpage, product_data, rank, backlinks, keyword_research, competitors, domain_score — see VisibilityAuditKind), how many external domains it may watch, how many it is using, how many products it may price-track, and the Zinn® credit balance an on-demand run would draw on. from_plan lists the products granted by the plan or a bundle rather than by a standalone add-on. An upsell surface must read it and say "included in your plan" instead of offering to sell a capability the customer already holds — a product is a switch you cannot hold twice, unlike the target allowance, which stacks. credit_balance_micros is the customer's own balance in USD micros. The response deliberately carries no figure for what a run costs Zinn® and no margin: that is on the admin surface only.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
products | VisibilityAuditKind[] | Yes | — |
from_plan | VisibilityAuditKind[] | Yes | Products granted by the plan or a bundle rather than by a standalone add-on. An upsell surface reads this and says "included in your plan" instead of offering to sell a capability… |
sellable | VisibilityAuditKind[] | Yes | — |
external_allowance | integer | Yes | — |
external_used | integer | Yes | — |
external_remaining | integer | No | — |
byo_seo_providers | string[] | No | SEO providers this organisation has connected its own API key for, by name (majestic, ahrefs, moz, dataforseo_backlinks). Their checks run against the customer's own… |
product_allowance | integer | No | How many products this organisation may price-track. A separate allowance from external_allowance on purpose: a target is a domain and costs the same whatever it sells,… |
mention_phrase_allowance | integer | No | How many phrases this organisation may listen for across the web (brand mentions), across all its domains. -1 means unlimited; 0 means brand mentions is not held. |
mention_check_allowance | integer | No | How many brand-mention checks a month the plan includes. -1 means unlimited. |
mention_checks_used | integer | No | Brand-mention checks already used this calendar month (UTC) — the same figure the scheduled checks spend against, so the screen cannot promise room they will not honour. |
keyword_allowance | integer | No | How many search phrases this organisation may track positions for. A third separate allowance, distinct from both external_allowance and product_allowance, because the… |
versions_allowance | integer | No | How many Google versions (a location and language a phrase is checked from) each tracked domain may use — V1's rank axis: Rank Tracking Starter 10, Pro 25, Agency 100, plus 10 per… |
rank_check_cadence | object | No | How often this organisation's rank phrases are checked right now, and why. null when rank tracking is not held. Read from the same helper the scheduled sweep asks at the point… |
allowances | SeoAllowances | No | Every allowance a V1-parity SEO tier sells, metered at the point of use. Monthly: audits (site audits), refreshes (backlink profile readings), lists (keyword research… |
credit_balance_micros | integer | No | The organisation's Zinn® credit balance in USD micros. |
Errors this endpoint can return
401 · 403 · 404