api
events

Changed on

Get public listing events

get/api/events/public/listings

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/events/public/listings
  • Auth: none declared

Query parameters

topnumber float
skipnumber float
startMinstring date-time
startMaxstring date-time
endMinstring date-time
endMaxstring date-time
sectionURLstring
sellerIdstring
orgIdstring
string[]
OR
string
groupEventIdstring
eventIdsstring[]
sortBy'start'
sortOrder'ASC' | 'DESC'
visibleInListingtrue
showStartDateboolean
localestring

Get the info for a specific language

eventType'SINGLE' | 'GROUP' | 'RECURRENCE'
underShopIdstring
attributesobject

Response

OK

_idstring required

The ID of the event

urlstring

The url of the event

namestring required

The name of the event

imagestring

An image for the event

sloganstring

The slogan of the event

sellerIdstring

The ID of the seller owning this event

startstring date-time required

An ISO timestamp indicating when the event starts

endstring date-time required

An ISO timestamp indicating when the event ends

locationNamestring

The name of the location where the event takes place

locationStreetstring

The street of the location where the event takes place

locationCitystring

The city of the location where the event takes place

locationPostalstring

The postal code of the location where the event takes place

locationCountrystring

The country code of the location where the event takes place

metaobject

Custom key-value data. Metadata is useful for storing additional, structured information on an object.

eventType'SINGLE' | 'GROUP' | 'RECURRENCE' | 'ROOT'

The type of the event. SINGLE = it is a single event. GROUP = the event is part of a group of events

childEventsstring[]

An array of IDs of child events

daySchemeIdstring

The ID of the day scheme assigned to the event.

rootIdstring

The id of the root event

useTimeSlotsboolean

Whether the event uses time slots.

underShopIdstring

The ID of the under shop of the event

startingPricestring

The starting price of the event

showStartDateboolean

Whether to show the start time of the event in listings or not

showEndDateboolean

Whether to show the end time of the event in listings or not

showTimeRangeInListingboolean

Whether to show the end time of the event in listings or not

availabilityIndicator'green' | 'yellow' | 'red'

The availability of the event. It shows whether there are tickets available. green = Enough available tickets. yellow = The tickets are almost sold out. red = There are no more available tickets

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK'

The currency of event tickets prices

saleStatus'onSale' | 'planned' | 'past' | 'soldOut'

status of event sale

timezonestring

Timezone of event

categorystring
subCategorystring
attributesobject

Changes

  • 4ef1e0466eb3Revision changes
    • warning

      added the new quarters enum value to the //// response property for the response status

    • warning

      added the new quarters enum value to the //// response property for the response status

    • warning

      added the new quarters enum value to the //// response property for the response status

    • warning

      added the new quarters enum value to the //// response property for the response status

    • warning

      added the new quarters enum value to the //// response property for the response status

    • warning

      added the new quarters enum value to the //// response property for the response status

    • info

      added the optional property // to the response with the status

  • 2df80ee6356cRevision changes
    • info

      added the optional property /// to the response with the status