---
title: "Get a list of roles"
method: GET
path: "/clients/{id_client}/roles"
tags: ["client_roles"]
---

# Get a list of roles

`GET /clients/{id_client}/roles`

## Request

- Base URL: `https://api.planvortex.com/v1.0.0`
- URL: `https://api.planvortex.com/v1.0.0/clients/{id_client}/roles`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://api.planvortex.com/v1.0.0/oauth/token`)

Return a list of client roles inside the received client

## Path parameters

- `id_client` string, required

## Query parameters

- `offset` integer
- `limit` integer

## Response `200`

Successful operation

- ClientsRolesRoleList
  - `roles` ClientsRolesRole[]
    - `name` string
    - `permissions` ClientsRolesClientPermissions[]
  - `total` integer

## Other responses

- `400`: The request failed. The body carries the PlanVortex error code in `code`: | Code | Meaning | | --- | --- | | `521` | Invalid client. The identifier is invalid o doesn't exists |
- `500`: Unhandled error by the server

---

[API](https://skmtc.dev/planvortex/apis/planvortex-api.md) · [All operations](https://skmtc.dev/planvortex/apis/planvortex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/planvortex/apis/planvortex-api/revisions/abedbbc1cd52?raw)