Event
An event represents a scheduled activity or occasion. You can create ticket types for the event with EventTicketType.
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
id* | string (UUIDv4) | Unique identifier | "bd4a0997-39db-41d9-883a-cdfa83e2101f" | |
createdAt | date | Creation timestamp of the event | "2024-01-15T09:30:00.000Z" | |
masterLanguage | string | Master language of the event | "en" | |
name* | string | Name of the event | "Summer Festival 2024" | |
description | string | Description of the event | "Annual summer celebration with music and activities" | |
startDate | date | Start date and time of the event | "2024-07-01T14:00:00.000Z" | |
endDate | date | End date and time of the event | "2024-07-03T22:00:00.000Z" | |
parentEventId | string (UUIDv4) | If it is part of a series, then it will have a parent event id | "bd4a0997-39db-41d9-883a-cdfa83e2101f" | |
published | boolean | false | Whether the event is publicly visible. This flag is considering also planned functionality. | true |
publishedAt | date | This is optional, since the event can be published right away. But there might be a date in the future or past. So if published is set to true, then it is published. Otherwise there might be info in this field on when the event will be published | "2024-01-15T09:30:00.000Z" | |
imageId | string (UUIDv4) | null | ID of an image associated with the event | "bd4a0997-39db-41d9-883a-cdfa83e2101f" |
translations | array | [] | A list of translation objects EventTranslation for the object | [{ language: "da", title: "Sommerfestival 2024", description: "Årlig sommerfest..." }] |
enableTickets | boolean | false | Whether tickets can be issued for this event | true |
ticketTypes | array | [] | A list of ticket types (EventTicketType) associated with this event | [{ id: "bd4a0997-39db-41d9-883a-cdfa83e2101f", title: "General Admission" }] |
onSale | boolean | true | A convenience field where you can check whether the event is on sale or not. The workspace is able to set all kind of rules for when the sale will start and finish and this field will dynamiccally update and take those settings into consideration | |
saleStartsAt | date | This field is optional and might include a date for when the sale starts for this event | ||
saleEndsAt | date | This field is optional and might include a date for when the sale will end for this event | ||
soldOut | boolean | false | Whether all tickets for this event have been sold. It takes max capacities into consideration for all ticket types and for the overall event. | true |
EventTranslation
An EventTranslation contains translated fields for the event object.
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
language* | string (ISO 639-1) | Language code for the translation | "da" | |
name | string | null | See description of field in Event | "Sommerfestival 2024" |
description | string | null | See description of field in Event | "Årlig sommerfest..." |
EventTicketType
An EventTicketType represents a type of ticket that can be issued for an event.
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
id* | string (UUIDv4) | Unique identifier | "bd4a0997-39db-41d9-883a-cdfa83e2101f" | |
masterLanguage | string | Master language of the event | "en" | |
name* | string | Name of the ticket type | "General Admission" | |
description | string | Description of the ticket type | "Standard entry ticket" | |
price | number | null | Price of ticket in lowest unit. Cents for EUR, USD etc. 0 = FREE | 2500 |
maxQuantity | number | null | Maximum number of tickets of this type that can be issued. Null means unlimited. | 1000 |
translations | array | [] | A list of translation objects EventTicketTypeTranslation for the object | [{ language: "da", title: "Standard billet", description: "Standard adgangsbillet" }] |
availableQuantity | number | Number of tickets still available for purchase | 850 | |
soldOut | boolean | false | Whether all tickets of this type have been sold | true |
addOn | boolean | false | Whether this ticket type is an add-on. This ticket type cannot be used as admittance to the event | true |
published | boolean | false | Whether this ticket type is publicly visible | true |
EventTicketTypeTranslation
An EventTicketTypeTranslation contains translated fields for the event ticket type object.
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
language* | string (ISO 639-1) | Language code for the translation | "da" | |
title | string | null | See description of field in EventTicketType | "Standard billet" |
description | string | null | See description of field in EventTicketType | "Standard adgangsbillet" |