Listar papéis da empresa

GET

/v1/companies/{companyId}/roles

Retorna a lista de papéis (roles) cadastrados para uma empresa.

Por padrão, a resposta traz apenas os papéis normais da empresa — identificador, nome e descrição. Os papéis globais internos da plataforma (compartilhados entre empresas) ficam de fora da listagem, a menos que o parâmetro de consulta global seja enviado como true. O parâmetro intern pode ser combinado para filtrar papéis internos da plataforma.

Esta resposta não inclui o array de permissões de cada papel — apenas os dados básicos de identificação. A atualização de um papel (PUT /v1/companies/roles/{roleId}) é uma substituição completa do objeto de permissões, sem leitura prévia pela API; por isso, recomendamos manter, do lado da integração, o conjunto completo de dados de cada papel (nome, descrição, tipo, flag de papel interno e permissões) como referência do estado desejado antes de qualquer atualização.

Requisição

Parâmetros de Caminho

Parâmetros de Consulta

Respostas

🟢200Lista de papéis

application/json

Lista de papéis cadastrados para a empresa (ou papéis globais, conforme os parâmetros de consulta).

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/companies//roles?global=undefined&intern=undefined'

Response Example

{
    "items": [
        {
            "id": "string",
            "name": "string",
            "description": "string"
        }
    ]
}

Modificado em 2026-07-28 20:38:32

Página anterior

Listar usuários da empresa

Próxima página

Atualizar papel