access
GET /v1/orgs/{orgId}/members
List the people in an organization.
प्रमाणीकरण
एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग members.read अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।
तपाईंको संस्थाको आइडी राख्ने ठाउँ
यो इन्डपोटले URL मा नै तपाईंको संस्थाको id लाई orgId को रूपमा लिन्छ। यसलाई पथ (path) मा राख्नुहोस् — यसको सट्टामा काम गर्ने कुनै हेडर वा क्वेरी प्यारामिटर छैन।
तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।
प्रयास गर्नुहोस्
कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/members \
-H "Authorization: Bearer zdk_live_…"लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्
विवरणहरू
The org's members with their roles, paged over users (a person holding two roles is one row, not two). Each row carries removable and, when false, not_removable_reason — the engine's own answer, so a client never re-derives the removal policy and offers a button that will be refused. Requires members.read; a caller without members.remove sees removable: false on everyone.
प्यारामिटरहरू
| नाम | प्रकार | आवश्यक | यो के हो |
|---|---|---|---|
orgId (path) | Uuid | हुन्छ | Organization ID (UUIDv7). |
cursor (query) | string | हैन | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | हैन | Maximum items to return (page size). |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यो के हो |
|---|---|---|---|
data | OrgMember[] | हुन्छ | — |
page | PageMeta | हुन्छ | — |
यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू
401 · 403 · 404 · 429