UserSearchParams
UserSearchParams interface.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
age? | string | Filter using age ranges. Possible values: -30, 30-45, 45+. The value 45+ must be encoded in the request url: 45%2B. | - |
category? | number | Filter using category ID. | - |
description? | string | Filter using field description. | - |
gender? | string | Filter using field gender type. | - |
is_staff? | boolean | Filter the users that belong to the staff. | - |
lat_lng? | string | Filter using coordinates lat,lng. | - |
limit? | number | Number of results to return per page. | BaseGetParams.limit |
location? | string | Filter using field location. | - |
offset? | number | The initial index from which to return the results. | BaseGetParams.offset |
ordering? | string | Ordering fields (eg?: ?ordering=username). Minus char is used for descending ordering, eg. -username. | - |
real_name? | string | Filter using field real_name. | - |
tag? | number | Filter using tag ID. | - |
user? | string | A search term. Search in fields: username, real_name. If this parameter is used username & real_name will be ignored. | - |
user_position? | string | Use the coordinates (position_lat_lng or location_lat_lng) of the authenticated user. | - |
username? | string | Filter using field username. | - |