admin

Staff viewset for managing users.

get/api/v2/admin/users/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie sessionid

Query parameters

emailstring
is_activeboolean
is_staffboolean
is_superuserboolean
is_systemboolean
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

searchstring

A search term.

usernamestring

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

    • breaking

      the // response property's maxLength was unset from 254 for the response status

    • info

      the response optional property // became read-only for the status

    • info

      the response property // became required for the status