tenancy

GET /v1/orgs/{orgId}

Get an organization.

Të gjitha pikat e skajshme tenancy

Autentifikimi

Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.

Ku shkon id i organizatës suaj

Ky endpoint merr ID-në e organizatës suaj direkt në URL, si orgId. Zëvendësoni atë në shteg — nuk ka asnjë kokë (header) apo parametër query që bën punë në vend të kësaj.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
  -H "Authorization: Bearer zdk_live_…"

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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

Parametrat

EmriLlojiKërkohetÇfarë është kjo
orgId (path)UuidPoOrganization ID (UUIDv7).

Përgjigja

EmriLlojiKërkohetÇfarë është kjo
idUuidPoUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypePoOrganization type in the tenancy tree.
parent_org_idUuid | nullJoParent in the tenancy tree; null for a top-level org.
namestringPo
brand_idobjectJoWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodePoISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>Po
created_atstringPo

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 404 · 429