Application API Search matches

#/matches

Performs a search using the current member’s “My Match” criteria - protected.

Supports basic matches, reverse matches, and mutual matches, via the variant optional parameter.

Parameters

• variant (string) [optional: default "matches"] - may also be "mutual" for mutual matches, or "reverse" for reverse matches
• any of the standard Search Control Parameters.
• the default excludes list is blocks, declines, likes.
• the default for sortby is relevance.

Response Messages

200 OK - success

The result contains the following fields:

• totalmatches - the total number of matches found in this search
• page - the current page number in the result set
• pagesize - the page size in the results (will be the same as the pagesize parameter passed in)
• currentpagesize - the actual number of results on the current page; will be less than or equal to pagesize on the last page of results
• users - an array of user status information for members that matched the search criteria, including additional relevance (0.0-1.0) and exactmatch (boolean) fields; if sortby "distance" was specified in the parameters then there will be an additional distance field in each user status information structure saying how many miles from the current member’s location each matched member is

{
  "totalmatches" : 317,
  "page" : 3,
  "pagesize" : 15,
  "currentpagesize" : 15,
  "users" : [
    { user status information },
    { user status information },
    ...
  ]
}