notices

GET `/v1/notices`

The notices to show at the top of this screen.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X GET https://api.zinndigital.com/v1/notices \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

docs/87. What the platform is currently telling this customer, on this route, in their language — already sanitised, already localised. ⛔ No permission key. Reading the notices aimed at you is not a privilege: gating it would mean a member whose role happens to lack org.read never learns their card needs re-adding. The audience is the scope — a notice reaches an organization only if it is explicitly everyone or that org is named in its audience. An untargeted notice reaches nobody, never everybody. Exactly one of body_html and body_i18n_key is populated (a database constraint). body_html is operator-authored and safe to render as HTML; body_i18n_key + body_params are rendered from the SPA's own catalogue.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`route (query)`	`string`	Ne	The dashboard path being rendered, e.g. `/billing/invoices`. Defaults to `/`. A query string is ignored, so a notice aimed at `/billing` does not vanish when the screen adds a tab.
`org_id (query)`	`string`	Ne	Narrow to one organization. Omitted, the caller's whole accessible subtree is considered, so a reseller admin sees a notice aimed at a client org they manage. An id outside that…

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`data`	`Notice[]`	Da	—

Pogreške koje ova krajnja točka može vratiti

401 · 429