Skip to main content
GET
/
api
/
v1
/
users
List users
curl --request GET \
  --url https://api.example.com/api/v1/users
{
  "total": 1,
  "items": [
    {
      "id": "<string>",
      "email": "<string>",
      "account_id": "<string>",
      "account_code": "<string>",
      "account_name": "<string>",
      "role_id": 123,
      "role_name": "<string>",
      "is_active": true,
      "auth_provider": "<string>",
      "email_verified": true,
      "created_at": "2023-11-07T05:31:56Z",
      "auth_provider_name": "<string>",
      "external_id": "<string>",
      "external_email": "<string>",
      "profile_data": {},
      "email_verified_at": "2023-11-07T05:31:56Z",
      "last_login": "2023-11-07T05:31:56Z"
    }
  ]
}

Query Parameters

​
account_id
string | null

Filter by account ID

​
role_id
integer | null

Filter by role ID

​
is_active
boolean | null

Filter by active status

​
search
string | null

Search by email

​
skip
integer
default:0

Number of records to skip

Required range: x >= 0
​
limit
integer
default:30

Maximum number of records to return

Required range: 1 <= x <= 100
​
sort
string
default:-created_at

Sort field with +/- prefix

Response

Successful Response

Response schema for listing users with pagination.

Attributes: total: Total number of users matching the filter. items: List of users for the current page.

​
total
integer
required

Total number of users

Required range: x >= 0
​
items
UserListItem · object[]
required

List of users