tenancy

GET /v1/orgs/{orgId}

Get an organization.

Svi tenancy krajnji točke

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 prihvaća ID vaše organizacije u samom URL-u, kao orgId. Zamijenite ga u stazi — ne postoji zaglavlje ili parametar upita koji će umjesto toga poslužiti.

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/orgs/{orgId} \
  -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

Returns a single organization the principal can access. RLS-scoped.

Parametri

NazivVrstaObaveznoŠto je to
orgId (path)UuidDaOrganization ID (UUIDv7).

Odgovor

NazivVrstaObaveznoŠto je to
idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeDaOrganization type in the tenancy tree.
parent_org_idUuid | nullNeParent in the tenancy tree; null for a top-level org.
namestringDa
brand_idobjectNeWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodeDaISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>Da
created_atstringDa

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

401 · 403 · 404 · 429