API Reference

Get Host Auction Details

This API is used to get host auction details like collected amount, a number of bidders, items with bids, paid bid items, total bids, etc. The event admin, super admin, and organizer admin can access this API.
We need to pass an authorization token here which is generated after successful login into the account.

  • Here is the description of response attributes, which returns in the form of JSON.
AttributeDescription
endDateEnd date of the auction.
collectedAmountCollected amount from this auction.
numberOfBidderNumber of bidders in the auction.
activeIs the module active or not?
statusModule status, the possible value will be EVENT_HAPPENING, PROCESSING_WINNER, WINNER_ANNOUNED, ERROR, EXTENDED_BIDDING, EVENT_MODULE_DELETED.
itemsWithBidsTotal number of items that have been bid on.
paidBidItemsTotal number of items which have paid bids.
totalItemsTotal number of items in the auction.
totalBidsTotal number of bids in the auction.
daysTotal number of event days.
  • Here are the possible error messages that return if any condition fails or required data is missing for processing.
Error CodeDescription
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
500Interna server error.
4030201Not event host.
Language
Credentials
Header
Click Try It! to start a request and see the response here!