Skip to main content

Get Auctions

Retrieves a paginated list of auctions.

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

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


Query Parameters

NameTypeRequiredDescriptionDefault Value
PageNumberintNoPage number to retrieve (1-based)1
PageSizeintNoNumber of auctions per page10

Sample Request

GET /api/Auctions?PageNumber=1&PageSize=10 HTTP/1.1
Authorization: Bearer {your_jwt_token}

Response

Status Code: 200 OK

Response Body Example

{
"success": true,
"message": "Auctions retrieved successfully.",
"data": [
{
"id": 789,
"productId": 123,
"ownerId": 456,
"title": "Vintage Guitar Auction",
"description": "A well-preserved vintage guitar from the 1960s.",
"startingPrice": 1500.0,
"minimumBidIncrement": 100.0,
"currency": "USD",
"startTime": "2025-06-10T14:00:00Z",
"endTime": "2025-06-12T14:00:00Z",
"status": "Pending"
}
// ... more auctions
]
}

Possible Error Responses

Status CodeMeaningWhen it Happens
401UnauthorizedJWT is missing or invalid
403ForbiddenCaller does not have permission to read auctions
429Too Many RequestsRate limiting exceeded
500Internal Server ErrorUnexpected server-side error