API Reference

Get goal details of Auction

This API will help to get all the item goal details and bid details for the auction of a given event URL. We need to pass an URL of the event to get all the item details of the auction.

Here is the description of response attributes, which returns to the form of JSON.

Attributes

Description

showTotalFundRaised

Is the total of fundraised needed to show on the event landing page?

fundRaisingGoal

Auction fundraising goal

bidInstructions

instruction of bid submit through SMS will display on the event landing page

totalRaised

the total amount submitted by the bidder. the value will be 0 when hideItemTotals is true

moduleEndDate

End date of auction module. After the end date reaches, bidders can't submit bids.

viewScrollSpeed

Scroll speed variable

Language
Credentials
Header
Click Try It! to start a request and see the response here!