get
https://api.accelevents.com/rest/events/
This API used to get event data with design details associated with the specified event.
This API can be access by event admin and super admin. It will return event data like accessToken, eventId, eventStatus, eventURL, address, eventDesignDetails, organizerName, createdDate and many more.
To call this API, user have to pass query param with API URL like eventurl, userKey and authentication key to authenticate user.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Here is the description of response attributes, which returns to the form of JSON.
It will return a success message if API execute successfully.
| Attribute | Description |
|---|---|
| eventId | This event ID represent unique ID of each event. It will generate automatically when it's create new event. |
| name | It's contains name of event. |
| eventURL | Event url is unique identifier for your event. E.g https://www.accelevents.com/events/demo. Here demo is the event url. |
| auctionEnabled | It will return the auction enabled or not. |
| auctionModuleShow | It will return the auction module show or hide. |
| auctionId | This auction ID represent unique ID of each event |
| latitude | It will return the event of latitude. |
| accessToken | It's access token for sms module.
|
| longitude | It's contains the event longitude. |
| fundANeedEnabled | It's contains the fund A Need enabled or not. |
| fundANeedModuleShow | It's contains the fundANeed module show or hide. |
| fundANeedId | The fundANeedId returns unique value associated with fundANeed. |
| raffleEnabled | It will return true then raffle is enabled otherwise false. |
| paymentGateway | This determines the payment gateway to which event host had connected the event to receive payments. |
| startDate | event start date in yyyy/MM/dd HH:mm format. |
| endDate | event end date in yyyy/MM/dd HH:mm format. |
| address | It's contains the ticketing venue address. |
| isRecurring | It will return the true then is recurring otherwise false. |
| organizerName | It's contains the name of organizer. |
| organizerPageURL | It's contains the page url of organizer. |
| raffleModuleShow | It's contains the raffle nodule hide or show. |
| raffleId | The raffleId returns unique value associated with raffle. |
| ticketingEnabled | It's check Is ticketing enabled or not. |
| ticketingId | The ticketingId returns unique value associated with ticketing. |
| donationEnabled | It will return the true then donation is enabled otherwise false. |
| textToGiveEnabled | It's check Is text to give enabled or not. |
| fundRaisingGoal | It will return the fund raising goal for specific event. |
| goalStartingAmount | It will return the starting amount of goal. |
| timezoneId | It's contains the timezone id, e.g. India Time, United States (New York) Time etc. |
| timezoneOffset | It's contains the timezone offset. |
| equivalentTimezone | This is timezone equivalent to custom timezone, e.g. Asia/Karachi, Asia/Calcutta, America/New_York. |
| phoneNumber | It's contains the country code wise phone number. |
| 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 |
| creditCardEnabled | It's check credit card are enabled or not. |
| ccRequiredForBidConfirm | Is credit card required for bid confirmation. |
| taxId | The taxId returns unique value associated with event. |
| createdDate | It contains the event's created date in the yyyy/MM/dd HH:mm format. |
| countryCode | It contains the country code of event, e.g. US, IN, ID. |
| currency | It will return the currency like HKD, USD, JPY, EURO. |
| currencySymbol | It's contains the symbol of currency, e.g. $, €, Mex$. |
| processingFeesToPurchaser | It's processing fees to purchaser for specific event. |
| enableBidderRegistration | It will return true then bidder registration is enable otherwise false. |
| auctionEnded | It will return true then auction has ended otherwise false. |
| raffleEnded | It will return true then raffle has ended otherwise false. |
| fundANeedEnded | It will return the true then fund a need has ended otherwise false. |
| ticketingEnded | It will return the true then auction has ended otherwise false. |
| eventStatus | It's contains the event status. It will be return either EVENT_HAPPENING, EVENT_ENDED, EVENT_WINNER_PROCESSING, NULL, EVENT_WINNER_ANNOOUNCED, EVENT_DELETED, |
| eventDesignDetails | It's contains the event design details
|
| analyticsId | It's contains the event google analytics Id. |
| trackingPixelId | It's contains the event facebook tracking pixel Id. |
| liveItemAvailable | It will return the live item is available or not. If available then return true otherwise false. |
| stripeKey | It's contains the key for stripe or square. |
| squareLocationId | It's contains the location Id of square. |
| isStripeConnectRequiredToTicketing | It will return the stripe connect required for ticketing or not. |
| ccProcessingEnabled | True when payment gateway is connected else will be false. |
Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.
| Error Code | Error Description |
|---|---|
| 200 | Successfully retrieved event data with design details. |
| 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. |
| 4040100 | User Not Found |