Listar Papéis (Roles)
Retorna a lista de papéis (roles) da empresa, incluindo permissões associadas a cada papel.
Cada papel contém informações como nome, perfil, descrição, quantidade de usuários vinculados e os grupos de permissões (claims) atribuídos.
curl -X GET "https://api-sandbox.contasimples.com/users/v1/roles" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api-sandbox.contasimples.com/users/v1/roles"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api-sandbox.contasimples.com/users/v1/roles", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api-sandbox.contasimples.com/users/v1/roles", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api-sandbox.contasimples.com/users/v1/roles')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"data": [
{
"id": "uuid-role-1234",
"name": "Contador(a)",
"profile": "ACCOUNTANT",
"description": "Papel com acesso a relatórios financeiros",
"recommendation": "Indicado para profissionais de contabilidade",
"users": 100,
"createdAt": "2025-06-15T10:30:00.000Z",
"updatedAt": "2025-07-01T14:00:00.000Z",
"deletedAt": "2025-08-01T12:00:00.000Z",
"claims": [
{
"id": "uuid-group-1234",
"name": "Transferências",
"permissions": [
{
"id": "uuid-claim-1234",
"slug": "consultar_dados_cartoes",
"name": "Consultar dados de cartões"
}
]
}
]
}
]
}
{
"error": "Bad Request",
"message": "Um ou mais parâmetros da requisição são inválidos.",
"code": 400,
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"details": [
"O campo exemplo deve ter um valor entre 5 e 100.",
"datas devem estar no formato YYYY-MM-DD."
]
}
{
"error": "Unauthorized",
"message": "Token de acesso inválido ou expirado.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 401
}
{
"error": "Not Found",
"message": "O recurso solicitado não foi encontrado.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 404
}
{
"error": "Internal Server Error",
"message": "Ocorreu um erro inesperado ao processar a solicitação.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 500
}
/users/v1/roles
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Bearer {token}Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Responses
Lista de papéis.
Identificador único do papel.
Nome de exibição do papel.
Tipo de perfil do papel.
CUSTOM_PROFILEDEVELOPERCARD_USERCARD_MANAGERRESPONSIBLEMAINACCOUNTANTDescrição do papel.
Texto de recomendação sobre quem deve utilizar o papel.
Quantidade de usuários vinculados ao papel.
Data de criação do papel (ISO 8601).
Data da última atualização do papel (ISO 8601).
Data de exclusão do papel (ISO 8601).
Lista de grupos de permissões (claims) atribuídos ao papel.
Identificador único do grupo de claims.
Nome de exibição do grupo de claims.
Lista de permissões neste grupo.
Identificador único da permissão (claim).
Identificador slug da permissão.
Nome de exibição da permissão.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Last updated today
Built with Documentation.AI