access
GET /v1/sites/{siteId}/collaborator-roles
The per-site roles that may be granted here.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/collaborator-roles \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
The roles a collaborator may be given on this site, so a form offers only choices the engine will accept. Fixed today; it exists because the first time a plan tier or a reseller policy limits which per-site roles may be conferred, every screen that hardcoded three choices is silently wrong and one that asked is not. `collaborator_role_seeded` reports whether the underlying organisation role exists in this deployment. It distinguishes *"nobody has been granted anything yet"* from *"the role catalogue was never seeded, so every grant will fail to narrow"* — two states that otherwise look identical from an empty list.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
siteId (path) | Uuid | Да | Site ID (UUIDv7). |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
items | object[] | Да | — |
collaborator_role_seeded | boolean | Да | Whether the `site_collaborator` organisation role exists in this deployment. See the endpoint description: it separates an empty answer from a blind one. |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 429