Filter matches across searches

Use this endpoint to lookup matches across all saved searches in your account, or across the saved searches of a specific client. Matches are listings that met a saved search's criteria. To list the matches of a single saved search, use GET /searches/{searchId}/matches.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
searchId
array of int32s

Limits results to the specified saved searches. Repeat the parameter to supply multiple searchIds.

searchId
int32
≥ 1

Limits results to matches for the saved searches of the specified client.

int32
≥ 1
Defaults to 1

The page number to return. For example, with 100 results per page, specifying pageNum=2 returns results 101–200.

int32
1 to 100
Defaults to 100

The number of matches to return per page.

date-time

If specified filters matches whose match date is >= the supplied value. Format: YYYY-MM-DDTHH:mm:ss.sssZ

date-time

If specified filters matches whose match date is <= the supplied value. Format: YYYY-MM-DDTHH:mm:ss.sssZ

int32
≥ 1

If specified, returns only the match with this matchId.

string

If specified, returns only matches for the listing with this mlsNumber.

boolean

If true filters search matches that were liked, if false filters search matches that were disliked. If not specified, returns all search matches.

boolean

If true filters search matches that the client has viewed, if false filters search matches that have not been viewed. If not specified, returns all search matches.

string
enum

If not specified returns both available and unavailable listings. If specified limits results to specified status.

Allowed values:

A,U

Allowed:
lastStatus
array of strings

If specified filters matches whose last status is one of the supplied values. Repeat the parameter to supply multiple values.

Allowed values:

Sus, Exp, Sld, Ter, Dft, Lsd, Sc, Lc, Pc, Ext, New, Sce, Cs, Lce, Inc

lastStatus
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json