Skip to main content

Interface: UserSearchParams

types/user.UserSearchParams

UserSearchParams interface.

Hierarchy​

Properties​

age​

• Optional age: string

Filter using age ranges. Possible values: -30, 30-45, 45+. The value 45+ must be encoded in the request url: 45%2B.

Defined in​

types/user.ts:82

category​

• Optional category: number

Filter using category ID.

Defined in​

types/user.ts:110

description​

• Optional description: string

Filter using field description.

Defined in​

types/user.ts:94

gender​

• Optional gender: string

Filter using field gender type.

Defined in​

types/user.ts:74

is_staff​

• Optional is_staff: boolean

Filter the users that belong to the staff.

Defined in​

types/user.ts:98

lat_lng​

• Optional lat_lng: string

Filter using coordinates lat,lng.

Defined in​

types/user.ts:86

limit​

• Optional limit: number

Number of results to return per page.

Inherited from​

BaseGetParams.limit

Defined in​

types/baseParams.ts:9

location​

• Optional location: string

Filter using field location.

Defined in​

types/user.ts:78

offset​

• Optional offset: number

The initial index from which to return the results.

Inherited from​

BaseGetParams.offset

Defined in​

types/baseParams.ts:13

ordering​

• Optional ordering: string

Ordering fields (eg?: ?ordering=username). Minus char is used for descending ordering, eg. -username.

Defined in​

types/user.ts:102

real_name​

• Optional real_name: string

Filter using field real_name.

Defined in​

types/user.ts:70

tag​

• Optional tag: number

Filter using tag ID.

Defined in​

types/user.ts:106

user​

• Optional user: string

A search term. Search in fields: username, real_name. If this parameter is used username & real_name will be ignored.

Defined in​

types/user.ts:62

user_position​

• Optional user_position: string

Use the coordinates (position_lat_lng or location_lat_lng) of the authenticated user.

Defined in​

types/user.ts:90

username​

• Optional username: string

Filter using field username.

Defined in​

types/user.ts:66