List users

Returns the users (staff accounts) that belong to your account, for example to show who created or updated a record (created_by, updated_by hold user IDs). Disabled users are left out unless you send include_disabled=1.

When the API user is set as the integration user of an integration in Settings, the list contains only that user.

Pagination. The page is in data: the users are in data.data, and data.next_page_url is null on the last page. There is no total count.

Responses

🟢200OK

application/json

One page of users. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "current_page": 1,
        "current_page_url": "https://api.hqrentals.app/api/users?page=1",
        "data": [
            {
                "id": 12,
                "email": "jane.doe@example.com",
                "username": "jane.doe",
                "full_name": "Jane Doe",
                "first_name": "Jane",
                "last_name": "Doe"
            },
            {
                "id": 15,
                "email": "john.smith@example.com",
                "username": "john.smith",
                "full_name": "John Smith",
                "first_name": "John",
                "last_name": "Smith"
            }
        ],
        "first_page_url": "https://api.hqrentals.app/api/users?page=1",
        "from": 1,
        "next_page_url": null,
        "path": "https://api.hqrentals.app/api/users",
        "per_page": 50,
        "prev_page_url": null,
        "to": 2
    }
}

Request

Responses