API Reference

Past Events for Item Upload

This API is used to get items from a past event using a CSV upload.

We need to pass the authentication token to authorize the user. This API can be accessed by admins, super admins, and white-label admins.

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

Attribute

Description

eventId

This represents the unique ID of each event. It will generate automatically when a new event is created.

name

Returns the name of the event.

auctionEnabled

Returns whether the auction module is enabled or not.

auctionModuleShow

Returns whether the auction module is shown or hidden on the participant side.

auctionId

The auction ID represent unique ID of each event.

latitude

Returns the latitude of the event's location.

accessToken

Returns the access token for SMS module.

  • *access_token:** Access token is required for all user related operation.
  • *expires_in:** It contains expiration time of the access token.
  • *redirectUrl:** It contains redirect Url based on the user's role.
  • *userId:** It contains user id.
  • *showExhibitorMenu:** It will return show exhibitor menu.
  • *userRole:** It shows role of user.
  • *whiteLabelURL:** White label url is a unique url which is managed and provided by white label admin.

longitude

Returns the longitude of the event's location.

fundANeedEnabled

Returns whether the Fund a Need module is enabled or not.

fundANeedModuleShow

Returns whether the Fund a Need module is shown or hidden on the participant side.

fundANeedId

Returns unique value associated with Fund a Need.

raffleEnabled

Returns whether the Raffle module is enabled or not.

paymentGateway

This determines the payment gateway that the event host has connected the event to receive payments.

startDate

Returns the event start date in yyyy/MM/dd HH:mm format.

endDate

Returns the event end date in yyyy/MM/dd HH:mm format.

address

Returns the event venue address.

isRecurring

Returns whether the event is recurring or not. If true then the event is recurring, otherwise false.

organizerName

Returns the name of organizer.

organizerPageURL

Returns the organizer page URL.

raffleModuleShow

Returns whether the Raffle module is shown or hidden on the participant side.

raffleId

The raffle Id returns the unique value associated with the raffle module.

ticketingEnabled

Returns whether the Ticketing module is enabled or not.

ticketingId

The ticketing Id returns the unique value associated with the ticketing module.

donationEnabled

Returns whether the Donation module is enabled or not.

textToGiveEnabled

Returns whether the Text to Give module is enabled or not.

fundRaisingGoal

Returns the fundraising goal for the event.

goalStartingAmount

Returns the starting amount of the fundraising goal.

timezoneId

Returns the timezone ID, e.g. India Time, United States (New York) Time etc.

timezoneOffset

Returns the timezone offset.

equivalentTimezone

Returns the time zone equivalent to custom timezone, e.g. Asia/Karachi, Asia/Calcutta, America/New_York.

phoneNumber

Returns the country code phone number.

accountActivatedTriggerStatus

If Facebook Pixel is activated this will return the trigger status. 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

Returns whether credit card processing is enabled or not.

ccRequiredForBidConfirm

Is credit card required for bid confirmation.

taxId

The tax Id returns unique value associated with event.

createdDate

It contains the event's created date in the yyyy/MM/dd HH:mm format.

countryCode

Returns the country code of the event, e.g. US, IN, ID.

currency

Returns the currency that is set for the event e.g. HKD, USD, JPY, EURO.

currencySymbol

Returns the symbol of currency, e.g. $, €, Mex$.

processingFeesToPurchaser

Returns the processing fees being paid for each order.

enableBidderRegistration

Returns whether bidder registration is enabled or not. If true, it is enabled.

auctionEnded

Returns whether the auction has ended or not. If true, it has ended.

raffleEnded

Returns whether the raffle has ended or not. If true, it has ended.

fundANeedEnded

Returns whether the fund a need has ended or not. If true, it has ended.

ticketingEnded

Returns whether ticketing has ended or not. If true, it has ended.

eventStatus

Returns the event status. It will return as one of the following: EVENT_HAPPENING, EVENT_ENDED, EVENT_WINNER_PROCESSING, NULL, EVENT_WINNER_ANNOUNCED, EVENT_DELETED,

eventDesignDetails

Returns the event design details.

  • *whiteLabelName: ** Returns the white label name for the specified white label event.
  • *whiteLabelUrl:** Returns the white label Url for the specified white label event.
  • *logoEnabled:** Returns whether the logo is enabled or not.
  • *logoImage** Returns the logo image for event design details.
  • *headerLogoImage:** Returns the header logo image for the specified event.
  • *notificationPopupImage:** Returns the notification popup image.
  • *headerColor:** Returns the header color for the specified event.
  • *headerFontColor:** Returns the color of the header font.
  • *bannerImageEnabled:** Returns whether the banner image is enabled or not.
  • *bannerImage:** Returns the banner image.
  • *description:** Returns the description of the specific event design details.
  • *totalFundRaisedShow:** Returns whether the total funds raised will show on the attendee side.
  • *socialSharingEnabled:** Returns whether social sharing enabled or not.
  • *intercomActivated:** Returns whether Intercom is activated or not.
  • *helpCenterActivated:** Returns whether the help center is activated or not.
  • *poweredByAeActivated:** Returns whether the "Powered by Accelevents" text will appear on the attendee facing side.
  • *billingPageEnabled:** Returns whether the billing page is enabled or not.
  • *marketingOptInHidden:** Returns whether the marketing opt-in is shown or not.
  • *marketingOptInChecked:** Returns whether the marketing opt-in is checked or not.
  • *defaultItemImage:** Returns the default item image.
  • *hideFundRaisingModuleToggle:** Returns whether the Fund a Need module is hidden or not.
  • *faviconDirectory:** Returns Favicon directory name For White Label.
  • *fbAppId:** Returns the Facebook App ID.
  • *whiteLabelHostBaseUrl:** Returns the white label host base URL.
  • *footerText:** Returns the footer text.
  • *whiteLabelUrl:** Returns the white label URL for the specified white label event.
  • *whiteLabelName:** Returns the White Label name for the specified white label event.
  • *auctionTabTitle:** Returns the auction tab title.
  • *fundANeedTabTitle:** Returns the Fund a Need tab title.
  • *raffleTabTitle:** Returns the raffle tab title.
  • *ticketingTabTitle:** Returns the ticketing tab title.
  • *donationTabTitle:** Returns the donation tab title.
  • *helpCenterURL:** Returns the help center URL.
  • *stripeDocumentationURL:** Returns the Stripe guideline document URL.
  • *signUpText:** Returns the sign up text.
  • *emailTemplateId:** Returns the default email template ID for contact emails.
  • *sponsorSection:** Returns the event sponsor section, if not passed it will appear empty.
  • *eventTagLine:** Returns the event tagline for display pages.
  • *displayBackgroundColor:** Returns the background color for the display.
  • *displayTextColor:** Returns the text color for the display.
  • *hideSponsorSection:** Returns the hide sponsor section.
  • *getStartedUrl:** Returns the Get Started URL.
  • *ticketingBuyButtonText:** Returns the buy tickets button text. It will return data like the button color, label, font and hide button.
  • *raffleBuyButtonText:** Returns the raffle buy tickets button text. It will return data like the button color, label, font and hide button.
  • *trackingScript:** Returns the tracking script.
  • *virtualEventScript:** Returns the virtual event script.
  • *themeId:** Returns the theme ID.
  • *orderConfirmationText:** Returns the message indicating that the order was successful to users after their ticket purchase.
  • *enableSessionsSpeakers:** Returns whether sessions & speakers are enabled or not.
  • *enableAutoAssignedSequence:** Returns whether auto-assigned attendee numbers are enabled or not.
  • *hideGoogleMap:** Returns whether the Google Maps widget showing the event location is hidden or not.
  • *donationButtonText:** Returns the donation button text. It will return data like Donation Button Color, Donation Button hidden or not and Button label.
  • *eventType:** Returns the event type.
  • *configureTabsAsJson:** Returns the tab configuration. Tabs can be: About, Agenda, Sponsor, Speakers, Exhibitors. Json contains the display order of the tab, name of the Tab, hide or unhide for the tab in JSON format.
  • *allowEndedEventAccess:** Returns whether attendees will be prevented from accessing the event after it ends.
  • *hideCreateEventButton:** Returns whether the create event button will be hidden or not.
  • *hideProductUpdateNotification:** Returns whether the product update notification button will be hidden or not.
  • *eventCalendarInvite:** Returns the event calendar invite.
  • *displayTabsColor:** Returns the tab colors for the display.
  • *displayTabsTextColor:** Returns the tab text colors for the display.
  • *showOrganizer:** Returns whether the organizer will be shown or not.
  • *adBlockerDocumentUrl:** Returns the ad blocker document URL.
  • *adBlockerLogoImage:** Returns the ad blocker logo Image.
  • *exitIntentContent:** Returns the exit intent popup content.

analyticsId

Returns the event Google analytics ID.

trackingPixelId

Returns the event's Facebook tracking pixel ID.

liveItemAvailable

Returns whether the live item is available or not. If available then it will return true, otherwise it will be false.

stripeKey

Returns the key for Stripe or Square.

squareLocationId

Returns the location ID of Square.

isStripeConnectRequiredToTicketing

Returns whether a Stripe connection is required for ticketing or not.

ccProcessingEnabled

Returns true when payment gateway is connected, anything else will be false.

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