API Reference

Get favorites

get
https://api.repliers.io/favorites

Returns a list of properties that a client has favorited. Results can be filtered by listing status, last status, and tags, making it easy to surface only the most relevant favorites.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Required if your account has access to multiple MLSes. Filters favorites to a specific board.

int32
required

The ID of the client whose favorites to retrieve.

string

Use if you want to limit the response to containing certain fields only. For example: fields?listPrice,soldPrice would limit the response to contain listPrice and soldPrice only. You can also specify the amount of images to return, for example if a listing has 40 images total and you specify fields=images[5] it will only return the first 5 images.

lastStatus
array of strings

Filters favorites by the last status of the favorited listing.

lastStatus
int32

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

int32

The number of favorites to return per page.

string

Filters favorites by the current status of the favorited listing.

string

Allows you to search tags within favorites, accepts a comma-separated string, for example "needs work, turn-key"

string

Accepts a value for latitude. Can be used only for sorting with distanceAsc or distanceDesc.

string

Accepts a value for longitude. Can be used only for sorting with distanceAsc or distanceDesc. Must be used with lat and radius parameters to return listings within a certain radius of a given latitude and longitude.

boolean

If true, returns the response in a human-readable formatted JSON.

string
enum

The attribute that the favorites will be sorted by. Note, distanceAsc and distanceDesc must be used in combination with lat, long parameters. Default is updatedOnDesc.

Responses

Updated about 1 month ago

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

Updated about 1 month ago