List company roles

GET

/v1/companies/{companyId}/roles

Returns the list of roles registered for a company.

By default, the response includes only the company's normal roles — identifier, name, and description. The platform's internal global roles (shared across companies) are excluded from the listing unless the global query parameter is sent as true. The intern parameter can be combined to filter the platform's internal roles.

This response does not include each role's permissions array — only basic identification data. Updating a role (PUT /v1/companies/roles/{roleId}) is a full replacement of the permissions object, with no prior read by the API; we therefore recommend keeping, on the integration side, the complete data set for each role (name, description, type, internal-role flag, and permissions) as the reference for the desired state before any update.

Requisição

Parâmetros de Caminho

Parâmetros de Consulta

Respostas

🟢200Role list

application/json

List of roles registered for the company (or global roles, depending on the query parameters).

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