GET /api/admin/users/

Returns all users with detailed information on each user, if the requesting user is staff.

Servers

Query parameters

Name Type Required Description
page Integer No

Defines which page should be returned.

sorts String No

A comma separated string of attributes to sort by, each attribute must be prefixed with + for a descending sort or a - for an ascending sort. The accepted attribute names are: id, is_active, name, username, date_joined, last_login. For example sorts=-id,-is_active will sort the users first by descending id and then ascending is_active. A sortparameter with multiple instances of the same sort attribute will respond with the ERROR_INVALID_SORT_ATTRIBUTE error.

size Integer No

Defines how many users should be returned per page.

search String No

If provided only users with id or username or first_name that match the query will be returned.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.