User

Authenticated paginated user search. Default scope matches handle, name, and (for q length >= 2) location. scope=mention matches handle and name only and omits users without a handle — use this from @mention typeahead so a city fragment cannot outrank a handle. limit is accepted (1–50, default 20). Each row uses profileUrl (not avatar); there is no level field. handle is nullable on the default scope and non-empty on scope=mention. location is always returned as a profile field; only the default scope uses it for matching and ranking.

get/api/user/search

Request

  • Base URL
    https://app.d-sports.org
  • Auth
    HTTP bearer

Query parameters

qstring required
pageinteger
limitinteger

Page size. Accepted; typeaheads should send their visible row count (e.g. 6) instead of slicing a full page client-side.

scope'mention'

Omit for the default explore search. mention matches handle and name only.

Response

{ success, data: { users, total, page, totalPages, query } }

successtrue required

Changes

    • breaking

      the query request parameter q became required

    • breaking

      for the query request parameter limit, default value 20 was added

    • breaking

      for the query request parameter page, default value 1 was added

    9 more changes in this revision