Skip to main content
GET
/
api
/
users
List users
curl --request GET \
  --url http://localhost/api/api/users \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "count": 123,
      "next": "<string>",
      "previous": "<string>",
      "results": [
        {
          "id": 123,
          "name": "<string>",
          "email": "jsmith@example.com",
          "is_active": true,
          "groups": [
            123
          ],
          "permissions": [
            123
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
searchString
string

Filter users by name

Response

200 - application/json

Successful Response

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"