Sign in
users
users

Discover Users

Discover users for language learning partnerships.

get/users/discover

Query parameters

language_filterstring nullable

Filter by native language

Filter by native language

learning_filterstring nullable

Filter by target language

Filter by target language

searchstring nullable

Search by username, full name, or bio

Search by username, full name, or bio

location_searchstring nullable

Search by location

Search by location

gender_filterstring nullable

Filter by user gender (male, female, non_binary)

Filter by user gender (male, female, non_binary)

sort_bystring nullable

Sort users by field (name, last_active, rating, reviews, recent)

Sort users by field (name, last_active, rating, reviews, recent)

online_onlyboolean nullable

Filter to show only online users

Filter to show only online users

school_onlyboolean nullable

Only show learners from the viewer's school(s)

Only show learners from the viewer's school(s)

limitinteger

Number of users to return

Number of users to return

offsetinteger

Number of users to skip

Number of users to skip

Headers

authorizationstring nullable

Response

Successful Response

idstring uuid required
usernamestring required
full_namestring nullable required
profile_picturestring nullable required
native_languagestring nullable required
native_languagesstring[]
target_languagesstring[] required
profile_dataobject required
interestsstring[]
last_login_atstring date-time nullable
average_ratingnumber nullable
review_countinteger
is_friendboolean
friend_request_statusstring nullable
account_typestring nullable
is_staffboolean
is_ai_personaboolean
school_namestring nullable
relationship_statusstring nullable
has_booking_todayboolean
starting_hourly_ratenumber nullable
currencystring nullable
badge_countinteger

Changes

No recorded changes to this endpoint across all 2 revisions of this API.