logo
UsersList roles

List roles

Returns the company’s roles, including permissions for each role.

Each role includes a name, profile, description, linked user count, and claim groups.

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": "Accountant",
      "profile": "ACCOUNTANT",
      "description": "Role with access to financial reports",
      "recommendation": "Recommended for accounting professionals",
      "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": "Transfers",
          "permissions": [
            {
              "id": "uuid-claim-1234",
              "slug": "consultar_dados_cartoes",
              "name": "View card data"
            }
          ]
        }
      ]
    }
  ]
}
GET
/users/v1/roles
GET
Bearer Token
Bearer Tokenstring
Required

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Responses

dataarray
Required

List of roles.