Skip to main content

Get list of favorite auctions

GET 
/api/auction/favorites

Retrieves the complete list of auctions marked as favorites by the company.

Features:

  • Paginated list
  • Sorted by creation date (most recent first)
  • Includes the associated auctions with their complete data
  • Optional filtering by text and dates

Optional query parameters:

  • page: Page number (default 1)
  • limit: Items per page (default value of ITEMS_PAGE in .env)
  • search: Text to search in fav_name or description
  • minDate/maxDate: Range of favorite creation dates

Usage example:

GET /api/auction/favorites?page=1&limit=10&search=urgent

The response includes pagination metadata and the basic fields for each favorite auction.

Responses​

Paginated list of favorite auctions. Each item includes:

  • All standard Auction fields
  • Additional favorite fields:
    • fav_name: Descriptive name assigned
    • createdAt: Favorite creation date
    • updatedAt: Date of last update

Pagination metadata:

  • total: Total favorites
  • pages: Total pages
  • page: Current page
  • limit: Items per page