Skip to main content
GET
/
v1
/
users
List users
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "user123",
      "identifiers": [
        {
          "id": "id1",
          "type": "email",
          "value": "user@company.com",
          "verified": true,
          "created_at": "2024-01-01T00:00:00.000Z",
          "verified_at": "2024-01-01T01:00:00.000Z"
        }
      ],
      "primary_identifier": {
        "id": "id1",
        "type": "email",
        "value": "user@company.com",
        "verified": true,
        "created_at": "2024-01-01T00:00:00.000Z",
        "verified_at": "2024-01-01T01:00:00.000Z"
      },
      "roles": [
        {
          "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
          "name": "admin",
          "permissions": [
            "user.create",
            "user.read",
            "role.create"
          ],
          "description": "Administrator role with full access",
          "company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
          "organization_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2794",
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2024-01-01T00:00:00.000Z"
        }
      ],
      "first_name": "John",
      "last_name": "Doe",
      "auth_methods": [
        "password"
      ],
      "suspended_at": "2024-01-01T00:00:00.000Z",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": false
  }
}

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 users per page

Required range: 1 <= x <= 100
sort
enum<string>

Sort string (e.g., -created_at). Allowed fields: created_at

Available options:
created_at,
-created_at

Response

Paginated list of users

data
object[]
required

Array of users

pagination
object
required