Skip to main content

Search Bids

Retrieves a paginated list of bids filtered by optional query parameters.

  • URI: /api/Bids/search
  • Method: GET
  • Authentication: Required (JWT)
  • Permission Required: Bids.Read (default value: "AuctionR:Bids:Read")

🔐 Permission values are configurable via the Permissions section in appsettings.json.


Query Parameters

NameTypeRequiredDescription
AuctionIdintNoFilter bids by the auction ID
BidderIdintNoFilter bids by the bidder's ID
MaxAmountdoubleNoFilter bids with amount less than or equal to this value
MinAmountdoubleNoFilter bids with amount greater than or equal to this value
PageNumberintNoPage number for pagination (default: 1)
PageSizeintNoNumber of results per page (default: 10)

Sample Request

GET /api/Bids/search?AuctionId=123&PageNumber=1&PageSize=10 HTTP/1.1
Authorization: Bearer {your_jwt_token}

Response

Status Code: 200 OK

Response Body Example

{
"success": true,
"message": "Bids retrieved successfully.",
"data": [
{
"id": 987,
"auctionId": 123,
"bidderId": 456,
"amount": 1700.0,
"timestamp": "2025-06-10T15:00:00Z"
}
// ... more bids
]
}

Possible Error Responses

Status CodeMeaningWhen it Happens
400Bad RequestInput validation fails (e.g., missing/invalid fields)
401UnauthorizedJWT is missing or invalid
403ForbiddenCaller does not have permission to create bids
429Too Many RequestsRate limiting exceeded
500Internal Server ErrorUnexpected server-side error