get https://api.accelevents.com/rest/host/event//auction/settings
This API is will return Auction host-side setting data such as accessToken, Auction status, event timezone, and more. This endpoint can be accessed by users with event admin access or greater. Users will need to pass an authentication token to authorize the user and pass eventUrl in path param.
Here is the description of response attributes, which returns to the form of JSON.
Attribute | Description |
---|---|
activated | Is the module activated? If not passed will be set to false. |
allowMultipleWinnersPerItem | Is Allow multiple winners per item? If not passed will be set to false. |
auctionStatus | It contains Auction Status like Event Happening, Processing Winner, Winner Announced, Bidding Extended, Event Module Deleted. |
categoryEnabled | Is category enabled? If not passed will be set to false. |
countDownTimeShow | Display count down? If not passed will set true. |
defaultBidIncrement | Default bid increment, if not passed will be set to 0. |
enableMarketValue | Is market value enabled? If not passed will be set to false. |
equivalentTimeZone | This is a timezone equivalent to a custom timezone. |
eventTimeZone | Selected Event Time Zone Id. |
extendedBiddingEnabled | Allowed to extend the auction end time? |
extendedBiddingWaitingTime(seconds) | It contains an integer value and indicates that the auction will extend up to this extendedBiddingWaitingTime. |
highestBidderShow | Is the highest bidder shown? If not passed will be set to true. |
lastExtendedEndTime | Item extended bidding end date. |
liveAuction | Is it a Live Auction? If not passed will be set to false. |
moduleShow | Show module tab on display page? If not passed will be set to false. |
pledgeButtonName | Used to set the custom name of the pledge button. |
requireUserAddress | Are fundraising participant mailing addresses to be collected? |
showItemTotals | Are Item Totals shown on the event landing page? |
timeZones | Returns list of available timezones. |
txtMsgBidInstShown | Show Text Message Bidding Instructions. |
userTime | End time of Fund A Need to submit a pledge. |