Skip to content
Fleet Manager

List users

GET
/api/v1/users
 
curl --request GET \
  --url 'http://localhost:3000/api/v1/users?search=john&email=john.doe%40example.com&active=true&isSuperAdmin=false&include=organizations&limit=50&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a list of all users. Requires Super Admin privileges.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
search
string
Example 
john

Search term for user name or email

email
string format: email
Example 
john.doe@example.com

Filter by exact email address

active
boolean
Example 
true

Filter by active status

isSuperAdmin
boolean
Example 
false

Filter by super admin status

include
string
Example 
organizations

Include related data. Use “organizations” to include organization memberships.

limit
number
default: 50 >= 1 <= 100
Example 
50

Maximum number of results to return

offset
number
0
Example 
0

Number of results to skip for pagination

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Users retrieved successfully

Media type application/json
object
items
required

List of users

Array<object>
object
id
required

Unique user identifier

string format: uuid
email
required

User email address

string format: email
name

User display name

string
active
required

Whether the user account is active

boolean
emailVerified
required

Whether the user email has been verified

boolean
isSuperAdmin
required

Whether the user is a super admin with platform-wide privileges

boolean
createdAt
required

When the user was created

string format: date-time
updatedAt
required

When the user was last updated

string format: date-time
lastLoginAt

When the user last logged in

string format: date-time
total
required

Total number of users matching the query

number
limit
required

Number of results returned

number
offset
required

Number of results skipped

number
Example 
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "john.doe@example.com",
      "name": "John Doe",
      "active": true,
      "emailVerified": true,
      "isSuperAdmin": false,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-06-20T14:45:00Z",
      "lastLoginAt": "2024-12-20T09:15:00Z"
    }
  ],
  "total": 100,
  "limit": 50,
  "offset": 0
}

401

Section titled “401 ”

Unauthorized

403

Section titled “403 ”

Forbidden - Super Admin required