Skip to content

Search users​

GET
/users

Lists the users of the company with filtering, sorting and pagination.

Authorizations​

BearerAuth
Type
HTTP (bearer)
Example"Bearer ..."

Parameters​

Query Parameters

name
Type
string
email
Type
string
fk_id
Type
string
id_group

ID of the Group

Type
integer
Minimum
1
limit
Type
integer
Minimum
1
Maximum
100
Default
25
page
Type
integer
Minimum
1
Default
1
sort
Type
string
Valid values
"id""name""email""created_at""updated_at""-id""-name""-email""-created_at""-updated_at"
Default
"-id"

Responses​

Successful operation

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"email": "string",
  
  
  
"phone": "string",
  
  
  
"fk_id": "string",
  
  
  
"active": true,
  
  
  
"group": {
  
  
  
  
"id": 0,
  
  
  
  
"name": "string"
  
  
  
}
  
  
}
  
],
  
"pagination": {
  
  
"page": 1,
  
  
"limit": 25,
  
  
"total": 100,
  
  
"totalPages": 4,
  
  
"hasNext": true,
  
  
"hasPrev": false,
  
  
"links": {
  
  
  
"self": "/orders?page=1&limit=25",
  
  
  
"first": "/orders?page=1&limit=25",
  
  
  
"last": "/orders?page=4&limit=25",
  
  
  
"next": "/orders?page=2&limit=25",
  
  
  
"prev": "string"
  
  
}
  
},
  
"meta": {
  
  
"timestamp": "2026-08-14T14:04:15",
  
  
"version": "1.0.0"
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI