members
GET /v1/members/invitations
List pending member invitations in scope.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението members.read; ключ без него се отхвърля с 403, а не с 404.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/members/invitations \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Returns the organization's **pending** invitations. Accepted/revoked invites are omitted. There is no secret in the payload — accept is authorized by the invitee's verified email (register #31). Requires `members.read`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
org_id (query) | Uuid | Не | Restrict to one organization in scope (default — the whole subtree). |
cursor (query) | string | Не | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Не | Maximum items to return (page size). |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
data | Invitation[] | Да | — |
page | PageMeta | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 429