Skip to main content
POST
/
v1
/
listings
/
featured
Get featured listings for a brokerage
curl --request POST \
  --url https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/listings/featured \
  --header 'Content-Type: application/json' \
  --header 'X-ARIS-API-Key: <api-key>' \
  --data '
{
  "brokerageId": "550e8400-e29b-41d4-a716-446655440000",
  "limit": 10,
  "page": 1
}
'
{
  "data": [
    {
      "listingId": "a12345",
      "address": "123 Main St, Austin, TX 78701",
      "city": "Austin",
      "state": "TX",
      "zip": "78701",
      "price": "450000",
      "beds": 3,
      "baths": 2,
      "sqft": "1850",
      "photos": [
        "<string>"
      ],
      "daysOnMarket": 14,
      "description": "<string>",
      "status": "Active",
      "detailsUrl": "<string>",
      "videoUrls": [
        {
          "url": "<string>",
          "title": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "hasMore": true
}

Authorizations

​
X-ARIS-API-Key
string
header
required

Body

application/json
​
brokerageId
string
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
agentId
string | null

Filter to a specific agent's featured listings.

​
officeId
string | null

Filter to a specific office's featured listings.

​
limit
integer
default:10
Example:

10

​
page
integer
default:1
Example:

1

Response

200 - application/json

Featured listings and pagination metadata.

​
data
object[]
​
total
integer
​
page
integer
​
limit
integer
​
hasMore
boolean