tenancy

GET /v1/orgs/{orgId}

Get an organization.

සියලුම tenancy අන්ත ලක්ෂ්‍ය

සත්‍යාපනය

බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. මෙම අන්ත ලක්ෂ්‍යය පිරිවිතරයේ නිශ්චිත අවසරයක් දක්වා නැත, එබැවින් උපකල්පනය කරනවාට වඩා ඔබේ යතුරට අවශ්‍ය අවම අවසරය ලබා දී ප්‍රතිචාරය පරීක්ෂා කරන්න.

ඔry ඔබේ සංවිධාන හැඳුනුම් අංකය (organisation id) ඇතුළත් කරන ස්ථානය

මෙම අවසන් ලක්ෂ්‍යය (endpoint) මඟින් ඔබේ සංවිධාන හැඳුනුම්පත (organisation id) URL එක තුළම orgId ලෙස ලබා ගනී. එය මාර්ගයට (path) ආදේශ කරන්න — ඒ සඳහා වෙනත් ශීර්ෂයක් (header) හෝ විමසුම් පරාමිතියක් (query parameter) නොමැත.

ඔබගේ සංවිධාන ID එක ඔබගේ පාලක පුවරුවේ ඇති API යතුරු තිරයේ, යතුරට ඊළඟින් දක්වා ඇත. ඔබ සිදු කරන සෑම ඇමතුමකදීම ඇත්තේ එම ID එකමය.

උත්සාහ කරන්න

<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්‍රතිස්ථාපනය කරන්න.

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

පද්ධතියට පිවිස සිටිනවාද? ඔබගේ උපකරණ පුවරුවේ ඇති API කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී API වෙත ඉල්ලීම ක්‍රියාත්මක කරන බැවින් ඔබට සැබෑ ප්‍රතිචාරය දැකගත හැක. මෙම අග්‍රලක්ෂ්‍යය API කොන්සෝලය තුළ විවෘත කරන්න

විස්තර

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

පරාමිතීන්

නමවර්ගයඅත්‍යවශ්‍යයිඑය කුමක්ද
orgId (path)Uuidඔව්Organization ID (UUIDv7).

පsspil

නමවර්ගයඅත්‍යවශ්‍යයිඑය කුමක්ද
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