logo
UsuáriosListar Papéis (Roles)

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"
{
  "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"
            }
          ]
        }
      ]
    }
  ]
}
GET
/users/v1/roles
GET
Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer \{token\}

Responses

dataarray
Required

Lista de papéis.