---
title: "GET /v1/roles"
method: GET
path: "/v1/roles"
tags: ["roles"]
---

# GET /v1/roles

`GET /v1/roles`

## Request

- Base URL: `//app.vindi.com.br/api` (relative, and the document’s source URL is not known)
- URL: `//app.vindi.com.br/api/v1/roles`
- Auth: HTTP basic

Retorna uma lista de perfis de acesso.

## Query parameters

- `page` integer
- `per_page` integer
- `query` string
- `sort_by` 'id' | 'base_role'
- `sort_order` 'asc' | 'desc'

## Response `200`

Consulta realizada com sucesso.

- Full[]
  - `id` integer, required: Id
  - `name` string, required: Translated name
  - `base_role` string, required: Perfil básico

## Other responses

- `400`: Erro de sintaxe JSON no corpo do request.
- `422`: Parâmetros inválidos. Verificar erro na resposta.

---

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