Search Users

POST /api/v1/users

Retrieve more users usingoffset parameter. Can also be used with filtering criteria such as email, first_name, etc.

{
  "email": "user@example.org",
  "first_name": "FIRST NAME",
  "last_name": "LAST NAME",
  "enabled_only": false,
  "offset": 0
}

Parameter	Type	Description
`email`	string	Wildcards are not allowed, however partial email string such as `user@example` will be matched.
`first_name`	string	Wildcards are not allowed, partial string will be matched
`last_name`	string	Wildcards are not allowed, partial string will be matched
`enabled_only`	boolean	Set `true` to only retrieve enabled users
`offset`	number	Defaults to `0`. The record number to start from when retrieving users. Calculate this using `total_users` and the `count` of actual users retrieved in the request

{
    "status": "OK",
    "total_users": 60,
    "count": 30,
    "users": [
        {USER_DATA_JSON}
        ]
}

Request

Successful operation