get
https://api.accelevents.com/rest/cache/events/
This API is used to get event data with design details associated with the specified event. It will return data like name, auctionEnabled, accountActivatedTriggerStatus, eventDesignDetails, eventType, eventId, eventStatus, eventURL etc.
To call this API, the user has to pass query param with API URL like eventUrl and authentication key to authenticate the user.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response
Here is the description of response attributes, which returns to the form of JSON.
| Attribute | Description |
|---|---|
| eventId | This event ID represents the unique ID of each event. It will generate automatically when it's creating a new event. |
| name | This contains the name of event data with design details. |
| eventURL | Event URL is a unique identifier for your event. E.g https://www.accelevents.com/events/demo. Here demo is the event URL. |
| accountActivatedTriggerStatus | Account activated trigger status for facebook pixel. It will return either INITIAL, READY_TO_FIRE_TRIGGER, TICKETING_ACTIVATED_TRIGGERED, AUCTION_ACTIVATED_TRIGGERED, RAFFLE_ACTIVATED_TRIGGERED, FUND_A_NEED_ACTIVATED_TRIGGERED, TEXT_TO_DONATE_ACTIVATED_TRIGGERED, MULTIPLE_MODULES_ACTIVATED_TRIGGERED |
| auctionEnabled | This will return if the auction is enabled or not. |
| auctionModuleShow | This will return if the auction module is shown or hidden. |
| auctionId | This auction ID represents the unique ID of each event. |
| latitude | This contains the event latitude |
| longitude | This contains the event longitude. |
| fundANeedEnabled | This returns if fund a need is enabled or not. |
| fundANeedModuleShow | This returns if the fund a need module is shown or hidden. |
| fundANeedId | The fund a need Id returns a unique value associated with fund a need. |
| raffleEnabled | This will return true if the raffle is enabled, false if it is not. |
| raffleModuleShow | This will return if the raffle module is hidden or shown. |
| raffleId | The raffle id returns a unique value associated with event data. |
| ticketingEnabled | This checks if ticketing is enabled or not. |
| ticketingId | The ticketing Id returns a unique value associated with ticketing. |
| eventDesignDetails | This contains the Event Design Details.
|
| donationEnabled | It will return the true if donations are enabled, otherwise false. |
| textToGiveEnabled | This is to check if text to give is enabled or not. |
| fundRaisingGoal | This will return the fundraising goal for a specific event. |
| goalStartingAmount | This will return the starting amount of the goal. |
| timezoneId | This contains the timezone id, e.g. India Time, United States (New York) Time, etc. |
| timezoneOffset | This contains the timezone offset. |
| equivalentTimezone | This is timezone equivalent to custom timezone, e.g. Asia/Karachi, Asia/Calcutta, America/New_York. |
| phoneNumber | This contains the country code-wise phone number. |
| creditCardEnabled | This checks if credit cards are enabled or not. |
| ccRequiredForBidConfirm | This is an option for if credit cards are required for bid confirmation |
| taxId | The tax id returns a unique value associated with an event. |
| createdDate | This contains the event's created date in the yyyy/MM/dd HH:mm format. |
| countryCode | This contains the country code of the event, e.g. US, IN, ID, etc. |
| currency | This will return the currency like HKD, USD, JPY, EURO. |
| currencySymbol | This contains the symbol of currency, e.g. $, €, Mex$. |
| processingFeesToPurchaser | This is the option to pass processing fees to purchasers for specific events. |
| enableBidderRegistration | This will return true if bidder registration is enabled, otherwise false. |
| auctionEndDate | This will return true if the auction has ended, otherwise false. |
| raffleEndDate | This will return true if the raffle has ended, otherwise false. |
| fundANeedEndDate | This will return true if fund a need has ended, otherwise false. |
| ticketingEndDate | This will return the true if the auction has ended, otherwise false. |
| eventStatus | It contains the event status. It will be returned either EVENT_HAPPENING, EVENT_ENDED, EVENT_WINNER_PROCESSING, NULL, EVENT_WINNER_ANNOOUNCED, EVENT_DELETED, |
| analyticsId | This contains the event google analytics Id. |
| trackingPixelId | This contains the event facebook tracking pixel Id. |
| liveItemAvailable | This will return if the live item is available or not. If available, it will return true, otherwise false. |
| stripeKey | This contains the key for Stripe or Square. |
| squareLocationId | This contains the location Id of Square. |
| isStripeConnectRequiredToTicketing | This will return if Stripe connection is required for ticketing or not. |
| ccProcessingEnabled | This will be true when payment gateway is connected, otherwise will be false |
| paymentGateway | This determines the payment gateway to which event host had connected the event to receive payments. |
| startDate | This contains the event start date in yyyy/MM/dd HH:mm format. |
| endDate | This contains the event end date in yyyy/MM/dd HH:mm format. |
| address | This contains the ticketing venue address. |
| isRecurring | This will return the true if the event is recurring, otherwise false. |
| organizerName | This contains the name of the organizer. |
| organizerPageURL | This contains the organizer page URL. |
| supportEnabled | This will check if Support is enabled or not |
Error Code
Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.
| Error Code | Error Description |
|---|---|
| 400 | The request could not be understood by the server due to malformed syntax. |
| 401 | You are not authorized to view the resource. |
| 403 | Accessing the resource you were trying to reach is forbidden. |
| 404 | The resource you were trying to reach is not found. |
| 40600013 | Can't create url |
| 4040200 | No Event could be found |