UsersGet Users
Users

GET /users

Retrieve a paginated list of users with optional filtering

curl -X GET "https://api.example.com/v2/users?page=1&limit=20&role=user&search=john" \
  -H "Content-Type: application/json" \
  -H "X-Request-ID: 123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com",
      "role": "user",
      "created_at": "2024-01-15T10:00:00Z",
      "last_active": "2024-12-25T15:30:00Z"
    },
    {
      "id": 2,
      "name": "Jane Smith",
      "email": "jane@example.com",
      "role": "admin",
      "created_at": "2024-02-20T14:30:00Z",
      "last_active": "2024-12-24T09:15:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "has_next": true
  }
}
GET
/users
GET
Security Scheme
X-API-Keystring
Required

API key for authentication. Get your API key from the dashboard.

API key for authentication. Get your API key from the dashboard.
query
pageinteger

Page number for pagination

Min: 1
query
limitinteger

Number of users per page

Min: 1 • Max: 100
query
rolestring

Filter users by role

Options: admin, user, viewer
header
X-Request-IDstring

Unique request identifier for tracing

Format: uuid
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. API key for authentication. Get your API key from the dashboard.

Query Parameters

pageinteger

Page number for pagination

limitinteger

Number of users per page

rolestring

Filter users by role

Headers

X-Request-IDstring

Unique request identifier for tracing

Responses

usersarray
paginationobject