Skip to main content
GET
/
v1
/
roles
List roles
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/roles \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "name": "admin",
      "permissions": [
        "user.create",
        "user.read",
        "role.create"
      ],
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "description": "Administrator role with full access",
      "company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "organization_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2794"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rinne.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT token for user authentication

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
limit
integer
default:20

Number of roles per page

Required range: 1 <= x <= 100
​
name
string

Filter by role name (partial match)

​
company_id
string

Filter by company ID

Response

Paginated list of roles

​
data
object[]
​
pagination
object