Concepts
Favorites
Bookmark a property server-side
A FavoriteProperty is a persisted reference to a Property, attached to the current API key. Handy for building a user-facing shortlist without persisting UUIDs yourself.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /favorite-properties | List favorites paginated (?page=N) |
POST | /favorite-properties | Add a property as favorite |
DELETE | /favorite-properties/{uuid} | Remove a favorite by UUID |
Add a favorite
curl -X POST "https://api-v2.stream.estate/favorite-properties" \
-H "X-API-KEY: <your_key>" \
-H "Content-Type: application/json" \
-d '{ "propertyId": "01926b8a-..." }'For the full FavoriteProperty field list, see /api-reference/favoriteproperty.