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 "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -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
Base URLstring

Target server for requests. Edit to use your own host.

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
header
Signature-Inputstring

What was signed and the signature parameters, in the RFC 9421 format. A credential with a public key must send it on every call, reads included, or the request is refused with 401. The signature covers the @method, @path, and @query components, and also content-digest when there is a body. created and alg are required, and created is valid for 300 seconds. The full format, with examples, is in Request Signing.

header
Signaturestring

The signature of the base defined by RFC 9421, in base64, between : and under the same label used in Signature-Input, for example sig=:SGVsbG8gd29ybGQ=:. It always goes together with Signature-Input.

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

Headers

Signature-Inputstring

What was signed and the signature parameters, in the RFC 9421 format. A credential with a public key must send it on every call, reads included, or the request is refused with 401. The signature covers the @method, @path, and @query components, and also content-digest when there is a body. created and alg are required, and created is valid for 300 seconds. The full format, with examples, is in Request Signing.

Signaturestring

The signature of the base defined by RFC 9421, in base64, between : and under the same label used in Signature-Input, for example sig=:SGVsbG8gd29ybGQ=:. It always goes together with Signature-Input.

Responses

dataarray
Required

List of access profiles.