Happy Endpoint

Get properties listed by an agency

Get all properties listed by a specific real estate agency. Uses the agency's external ID to fetch their property listings.

GET
/agency-properties

Authorization

RapidApiKey
X-RapidAPI-Key<token>

In: header

Query Parameters

agency_external_id*string
  • Agency external ID
  • Get from /agency-search or /agency-search-by-name response (externalID field)
  • Example: 106317
Length1 <= length
page?integer
  • Page number (starts from 1)
  • Results per page: 25
Default1
Range1 <= value
langs?string
  • Comma-separated language codes: en, ar, ru, zh
Default"en"

Header Parameters

X-RapidAPI-Host*string
Default"bayut14.p.rapidapi.com"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/agency-properties?agency_external_id=106317" \  -H "X-RapidAPI-Host: bayut14.p.rapidapi.com"
{
  "success": true,
  "data": {
    "properties": [
      null
    ],
    "total": 0,
    "page": 0,
    "totalPages": 0,
    "hitsPerPage": 0
  }
}
{
  "success": false,
  "message": "Invalid request: Missing required parameter",
  "error": "VALIDATION_ERROR"
}
{
  "success": false,
  "message": "Internal server error. Please try again later.",
  "error": "INTERNAL_ERROR"
}
{
  "success": false,
  "message": "Service temporarily unavailable. Please try again later.",
  "error": "API_ERROR"
}