Retrieve Users

GET /api/v1/users

User Administrator can retrieve all users within their user group. A maximum of 30 users can be retrieved in one request. Use the total_users and offset parameter to retrieve more users.

RESPONSE JSON

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

Key	Value	Description
`status`	string	`OK` if request was successfully received, `ERROR` if request cannot be processed
`total_users`	number	Total users in the user group
`count`	number	Users in the response
`users`	List	List of User JSON

Responses

Successful operation

Retrieve Users

/api/v1/users

RESPONSE JSON​

Responses​

RESPONSE JSON

Responses