GET
/
users
Retrieve a list of users
curl --request GET \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users
{
  "results": [
    {
      "id": "674d0bf5c28b69001f8e03a1",
      "created_at": "2024-04-22T10:00:00Z",
      "updated_at": "2024-04-22T10:00:00Z",
      "user_name": "john_doe",
      "email": "johndoe@gmail.com",
      "password": "P@ssw0rd!",
      "role": "manager"
    }
  ],
  "total_results": 20
}

Query Parameters

​
sort
string

Sort the list in the response by a specific property. Used with the order parameter.

​
order
string

Set the sort order to asc for ascending or desc for descending. Must be used with the sort parameter.

​
fields
string

Restrict which properties are returned in the response.

​
filter
string

Filter the response to include only items that have properties equal to the specified value.

Example:

"created_at.gt~2024-05-07|user_name.eq~apiuser01"

​
limit
integer

Limit the number of objects in the response.

Required range: x <= 30
​
offset
integer

Offsets the start of the list by the set value. Defaults to 0.

Example:

0

Response

200
application/json

Request successful

The response is of type object.