access
GET /v1/sites/{siteId}/collaborator-roles
The per-site roles that may be granted here.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/collaborator-roles \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
items | object[] | Sim | — |
collaborator_role_seeded | boolean | Sim | Whether the `site_collaborator` organisation role exists in this deployment. See the endpoint description: it separates an empty answer from a blind one. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429