Get Favorites

OverviewCopy Anchor Link

Returns all favorited properties for the authenticated member. Can be filtered to show favorites from a specific collection or all favorites across collections.

AuthenticationCopy Anchor Link

Requires a valid Clerk JWT token in the Authorization header.

Query ParametersCopy Anchor Link

curl -X GET "http://localhost:3000/v1/members/me/collections/favorites" \
  -H "Authorization: Bearer YOUR_CLERK_JWT"

ResponseCopy Anchor Link

[
  {
    "propertyDocumentId": "prop_luxury_maldives",
    "propertyName": "Luxury Resort Maldives",
    "propertySlug": "luxury-resort-maldives",
    "heroImageUrl": "https://cdn.journey.com/properties/maldives-hero.jpg",
    "collectionId": 1,
    "addedAt": "2024-04-15T14:30:00Z"
  },
  {
    "propertyDocumentId": "prop_santorini_villa",
    "propertyName": "Santorini Villa",
    "propertySlug": "santorini-villa",
    "heroImageUrl": "https://cdn.journey.com/properties/santorini-hero.jpg",
    "collectionId": 1,
    "addedAt": "2024-04-16T09:20:00Z"
  },
  {
    "propertyDocumentId": "prop_tokyo_business",
    "propertyName": "Tokyo Business Hotel",
    "propertySlug": "tokyo-business-hotel",
    "heroImageUrl": "https://cdn.journey.com/properties/tokyo-business-hero.jpg",
    "collectionId": 2,
    "addedAt": "2024-04-10T16:45:00Z"
  },
  {
    "propertyDocumentId": "prop_paris_boutique",
    "propertyName": "Paris Boutique Hotel",
    "propertySlug": "paris-boutique-hotel",
    "heroImageUrl": "https://cdn.journey.com/properties/paris-boutique-hero.jpg",
    "collectionId": null,
    "addedAt": "2024-04-08T12:15:00Z"
  }
]

Filtering OptionsCopy Anchor Link

All FavoritesCopy Anchor Link

• No collectionId parameter: Returns all favorites across all collections
• Use case: Master view of all favorited properties

Specific CollectionCopy Anchor Link

• collectionId=1: Returns favorites only from collection ID 1
• Use case: View favorites within a specific themed collection

Default CollectionCopy Anchor Link

• collectionId=null: Returns favorites in the default (unsorted) collection
• Use case: View favorites that haven't been organized into collections

Collection AssociationsCopy Anchor Link

collectionId ValuesCopy Anchor Link

• null: Property is in the default "Favorites" collection
• number: Property is in a specific user-created collection
• Multiple: Properties can be in multiple collections (not currently supported)

Collection ContextCopy Anchor Link

The collectionId field helps understand the organization:

• Use it to group favorites by collection in your UI
• Filter by collection for focused browsing experiences
• Show collection context when displaying individual favorites

SortingCopy Anchor Link

Favorites are returned in chronological order:

• Most Recent First: Newest favorites appear first
• addedAt Field: Use for custom sorting if needed
• Consistent: Order is stable across requests

Property InformationCopy Anchor Link

Each favorite includes:

• Identification: Document ID for API calls, slug for URLs
• Display: Name and hero image for UI rendering
• Context: Collection membership and favorite date
• Linking: Slug can be used to build property detail URLs

Related EndpointsCopy Anchor Link

• Add Favorite - Add a property to favorites
• Remove Favorite - Remove a property from favorites
• Check Favorite Status - Check if property is favorited