v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Listing

Search by Agent / Office

Searches active and sold listings for a specific agent (the caller by default), their office, or a set of MLS listing IDs.

Notes:

  • limit must be in (0, 1000]; otherwise 400 LISTING_LIMIT_NOT_VALID.
  • listingId and soldListingId cannot be supplied together; doing so returns an error envelope on HTTP 200.
  • At least one of agentListings, officeListings, listingId, soldListingId, mlsListingIds, buildingName, or buildingAddress must identify the search target.
  • When userId differs from the caller, caller must have MANAGE_TEAM_AGENT permission.
get/v1.0/listing

Query parameters

userIdinteger
listingIdstring
nextPageKeystring
soldNextPageKeystring
mlsListingIdsstring
streetstring
limitinteger
soldListingIdstring
officeListingsboolean
agentListingsboolean
buildingNamestring
buildingAddressstring
showConditionboolean

Headers

Authorizationstring required

Bearer [access_token]

Response

Search result envelope with active listings, sold listings, and listing metadata.

listIngobject

Active listings matching the search. Structure is a listing hub payload; fields depend on the listing source.

soldListingobject

Sold listings matching the search. Same structure as listIng.