احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز members.read باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی، شناسه سازمان شما را مستقیماً در خود URL به صورت orgId دریافت میکند. آن را در مسیر جایگزین کنید؛ هیچ هدر یا پارامتر کوئریای وجود ندارد که بتواند جایگزین آن شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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