Uthibitishaji
Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.
Mahali ambapo kitambulisho cha shirika lako huwekwa
Kituo hiki cha mwisho kinachukua kitambulisho cha shirika lako katika URL yenyewe, kama orgId. Kiweke kwenye njia — hakuna kichwa au kigezo cha hoja ambacho kitafanya kazi badala yake.
Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.
Jaribu
Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…"Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API
Maelezo
Returns a single organization the principal can access. RLS-scoped.
Vigezo
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
orgId (path) | Uuid | Ndiyo | Organization ID (UUIDv7). |
Majibu
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
id | Uuid | Ndiyo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Ndiyo | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Hapana | Parent in the tenancy tree; null for a top-level org. |
name | string | Ndiyo | — |
brand_id | object | Hapana | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Ndiyo | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Ndiyo | — |
created_at | string | Ndiyo | — |
Hitilafu ambazo mwisho huu unaweza kurudisha
401 · 403 · 404 · 429