List users

GET

https:/api.example.com/v1/users

Retrieve a list of users with optional filtering and pagination

Query parameters

page
integer
Defaults: 1
Page number for pagination
Required range: x >= 1
limit
integer
Defaults: 20
Number of items per page
Required range: 1 <= x <= 100
search
string
Search term for filtering users

Response

Successful response

data
array of object
Required
- id
  string
  Required
  Unique identifier for the user
- email
  string
  Required
  User's email address
- firstName
  string
  Required
  User's first name
- lastName
  string
  Required
  User's last name
- role
  enum
  Required
  User's role in the system
  user
  string
  admin
  string
  moderator
  string
- isActive
  boolean
  Required
  Whether the user account is active
- createdAt
  string
  Required
  When the user was created
- updatedAt
  string
  Required
  When the user was last updated
pagination
object
Required
- page
  integer
  Required
  Current page number
- limit
  integer
  Required
  Number of items per page
- total
  integer
  Required
  Total number of items
- totalPages
  integer
  Required
  Total number of pages

Example request

curl --request  \
     --url 'https://api.example.com/v1?page=1&limit=20&search=string' \
     --header 'accept: application/json'

Example response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "user@example.com",
      "firstName": "string",
      "lastName": "string",
      "role": "user",
      "isActive": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}

Create user

Built with