api
events

Changed on

Get an Event

get/api/events/{id}

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/events/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

Response

OK

_idstring required

The ID of the event

sellerIdstring

The ID of the seller owning this event

namestring required

The name of the event

sloganstring

The slogan of the event

descriptionstring

A description about the event. Description is in RichText - JSON format.

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

imagestring

An image for the event

ticketFooterstring

A footer image for the ticket PDF of the event

ticketBackgroundstring

A background image for the ticket PDF of the event

ticketShopHeaderstring

A header image for the ticket shop of the event

createdAtstring date-time

An ISO timestamp indicating when the event was created

updatedAtstring date-time

An ISO timestamp indicating when the event was updated

startstring date-time required

An ISO timestamp indicating when the event starts

endstring date-time required

An ISO timestamp indicating when the event ends

sellStartstring date-time

An ISO timestamp indicating when the event sale starts

sellEndstring date-time

An ISO timestamp indicating when the event sale ends

maxAmountnumber float required

Maximum amount of tickets of the event

maxAmountPerOrdernumber float required

Maximum amount of tickets per order of the event

maxAmountPerCustomernumber float

Maximum amount of tickets per customer of the event

maxTransactionsPerCustomernumber float

Maximum amount of transactions per customer of the event

minAmountPerOrdernumber float

Minimum amount of tickets per order

customerTagsstring[]

An array of customer tags of the event

customerSegmentsstring[]

An array of customer segments of the event

showCountdownboolean

Whether the countdown should be visible till event start

hideInListingboolean

Whether the event should be hide in listings

visibleAfterstring date-time

An ISO timestamp indicating when the event is visible in listings.

accentColorstring

The accent color of the event page

pageStylestring

The page style of the event page

showOtherEventsboolean

Whether other events should be displayed on the event page

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

urlstring

The url of the event

tagsstring[]

An array of tags of the event

rootIdstring

The id of the root event

daySchemeIdstring

The ID of the day scheme assigned to the event.

metaobject

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

timezonestring

Timezone of event

useTimeSlotsboolean

Whether the event uses time slots.

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

    • 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

    • 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

  • 141dfac7c804Revision changes
    • info

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

    • info

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

    • info

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