users

List users

Use this method to list users.

get/users/

Query parameters

activeboolean

Select only active users (true) or inactive (false) users

date_joined_gtstring date-time

Select objects with date_joined greater than this value

date_joined_gtestring date-time

Select objects with date_joined greater than or equal to this value

date_joined_ltstring date-time

Select objects with date_joined less than this value

date_joined_ltestring date-time

Select objects with date_joined less than or equal to this value

groupsinteger[]

Select users belonging to this group.

has_faceboolean

Select only users with uploaded image (true) or without an image (false)

id_ininteger[]

Select users with provided ids

language'en-us' | 'es' | 'ru'

Get users with this language selected

limitstring

Number of results to return per page.

orderingstring

Which field to use when ordering the results. Available fields: id, date_joined, modified_date, username, first_name, last_name, primary_group, is_active

pagestring

Pagination cursor value.

primary_groupinteger[]

Select users whose primary group is this group.

real_name_containsstring

Select users where the SQL condition real_name ILIKE real_name_contains is true

username_containsstring

Select users where the SQL condition username ILIKE username_contains is true

Response

next_pagestring nullable
prev_pagestring nullable

Changes

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