UPuptime
users

GET /api/v1/users/

List all users

Request

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

ordering'pk' | '-pk' | 'last_name' | '-last_name' | 'first_name' | '-first_name' | 'email' | '-email'

Order results by this field.

emailstring

Filter by email address.

access_level'10-READ' | '30-WRITE' | '50-ADMIN'

Filter by access level.

subaccountstring

Filter by users that have access to this subaccount ID.

is_activeboolean

Filter by whether the user is active.

is_api_enabledboolean

Filter by whether the API is enabled for this user.

notify_paid_invoicesboolean

Filter by whether invoices are sent to this user.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.