tenancy

GET /v1/orgs/{orgId}

Get an organization.

ټول tenancy پای ټکي

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی ستاسو د سازمان آی ډي په خپله په URL کې د orgId په توګه اخلي. دا په لاره کې ځای پرځای کړئ — هیڅ سرلیک یا پوښتنې پیرامیټر شتون نلري چې د دې پرځای کار وکړي.

ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د API کېلي پر سکرین، خپله د کېلي څنګ ته شتون لري. دا په هره هغه غوښتنه کې چې تاسو یې کوئ، ورته آی ډي وي.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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

پارامترونه

نومډولاړیندا څه شی دی
orgId (path)UuidهوOrganization ID (UUIDv7).

ځواب

نومډولاړیندا څه شی دی
idUuidهوUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeهوOrganization type in the tenancy tree.
parent_org_idUuid | nullنهParent in the tenancy tree; null for a top-level org.
namestringهو
brand_idobjectنهWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodeهوISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>هو
created_atstringهو

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 429