API Reference

Get general settings details

This API is used to return data like currency, fundRaisingGoal, goalStartingAmount, raffleEnabled, currencySymbol and many more. This endpoint can be accessed by users with event admin access or greater.

if the API is executed successfully. Here is the description of response attributes, which returns to the form of JSON.

Attribute

Description

currency

Returns a currency code like EUR, FRANC

fundRaisingGoal

Returns the fundraising goal, if not passed default will be 0.

goalStartingAmount

Returns the goal starting amount, if not passed default will be 0.

silentAuctionEnabled

Returns silent auction enabled value. Contains a boolean value. If silent auction enabled value is not passed default will be false.

raffleEnabled

Returns raffle enabled value. Contains a boolean value. If raffle enabled value is not passed, default will be false.

causeAuctionEnabled

Returns cause action enabled value. Contains a boolean value. If cause action enabled value is not passed, default will be false.

donationEnabled

Returns donation enabled value. Contains a boolean value. If donation enabled value is not passed, default will be false.

ticketingEnabled

Returns ticketing enabled value. Contains a boolean value. If ticketing enabled value is not passed, default will be false.

textToGiveEnabled

Returns text to give enabled value. Contains a boolean value. If the text to give enabled value is not passe,d default will be false.

analyticsId

Contains a google analytics ID for display pages. If not passed, default will be null. Only 255 Characters are allowed.

totalFundRaisedShow

Contains a boolean value for total funds raised shown.

socialSharingEnabled

Contains a social sharing enabled value. it returns a value in boolean.

replyToEmail

Contains a default email address. Email size should be 75 and only 75 caracters are allowed in email.

trackingScript

Contains tracking script.

virtualEventScript

Contains virtual event script.

textToGiveAvailableUntil

Contains Text To Give Available Until
value. The default value is null.

textToGiveSubscriptionStatus

Contains Text To Give subscription status.
The default value is null.

eventVenueType

it contains event venue type like Venue To be announced, VIRTUAL

trackinPixelId

Contains facebook tracking pixel ID for display pages. If not passed, default will be null.
Only 255 characters are allowed.

currencySymbol

Contains currency symbol like $,€.

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