--- title: "GET /api/pos/{id}/events" method: GET path: "/api/pos/{id}/events" tags: ["api", "pos"] --- # GET /api/pos/{id}/events `GET /api/pos/{id}/events` Get pos events ## Path parameters - `id` string, required ## Query parameters - `top` number, float - `skip` number, float - `startMin` string, date-time - `startMax` string, date-time - `endMin` string, date-time - `endMax` string, date-time - `sellStart` string, date-time - `sellEnd` string, date-time - `rootId` union - string[] - string - `sortBy` 'start' - `sortOrder` 'ASC' | 'DESC' - `locale` string — Get the info for a specific language - `eventTypes` string[] - `name` string ## Response `200` OK - GETPosGetPosEvents200Response - `docs` POSListingEventResource[] - `_id` string, required — The ID of the event - `url` string — The url of the event - `name` string, required — The name of the event - `image` string — An image for the event - `slogan` string — The slogan of the event - `sellerId` string — The ID of the seller owning this event - `start` string, date-time, required — An ISO timestamp indicating when the event starts - `end` string, date-time, required — An ISO timestamp indicating when the event ends - `locationName` string — The name of the location where the event takes place - `locationStreet` string — The street of the location where the event takes place - `locationCity` string — The city of the location where the event takes place - `locationPostal` string — The postal code of the location where the event takes place - `locationCountry` string — The country code of the location where the event takes place - `styleOptions` object — Style options of the event page - `headerStyle` string — Header style of the event page - `brandOne` string — First brand of the event - `brandTwo` string — Second brand of the event - `hideLocationMap` boolean — Whether the location map on the event page hide - `hideLocationAddress` boolean — Whether the location address on the event page hide - `categoryAlignment` number, float — The style of category alignment. 0 = cascade = categories among themselves. 1 = asTabs = categories as tabs. 2 = boxes = categories as boxes. 3 = ticket wizard = categories as ticket wizard if configured. - `showAvailabilityIndicator` boolean — Whether the availability indicator on the event page should be shown - `availabilityIndicatorThresholds` number[] — The availability indicator thresholds of the event - `showAvailable` boolean — Whether to show availability of the time slot. Only applicable for time slot events. - `timeSlotsCheckoutSelection` 'beforeTickets' | 'afterTickets' — Time slots selection in checkout. - `accountSettings` object — Account settings of the event - `_id` string, required — The ID of the account settings of the event - `enforceAccounts` boolean — Whether to enforce accounts for the event - `enforceAuthentication` 'DISABLED' | 'PREVENT_CHECKOUT' | 'PREVENT_DETAILS_STEP' — Whether to enforce authentication for the event and how to enforce it - `meta` object — 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 - `childEvents` string[] — An array of IDs of child events - `daySchemeId` string — The ID of the day scheme assigned to the event. - `rootId` string — The id of the root event - `seoSettings` object — The search engine optimization settings of the event - `_id` string, required — The ID of the SEO setting - `tags` string[] — An array of tags of the seo settings - `noIndex` boolean — Whether the seo setting has no indexing - `title` string — The title of the seo settings - `description` string — The description of the seo settings - `customSettings` object — Custom settings of the event - `_id` string, required — The ID of the custom settings of the event - `hideTicketsInTransactionPage` boolean — Whether the ticket types of the event should be visible on transaction page - `dontSendTicketMail` boolean — Whether an email should be sent of tickets of the event - `dontSendBookingConfirmationMail` boolean — Whether an email should be sent for booking confirmation - `customMailHeaderImage` string — A custom header image of the mail for ticket types of the event - `customTransactionCompletionText` string — A custom transaction completion text for completed transactions of the event - `disableAppleWallet` boolean — Whether the Apple and Google Wallet functionality should be disabled on the event. Deprecated: use event.deliverySettings.wallet instead - `disablePdfTickets` boolean — Whether the PDF tickets download functionality should be disabled on the event. Deprecated: use event.deliverySettings.pdf instead - `showStartDate` boolean — Whether the start date of the event should be visible on listings - `showStartTime` boolean — Whether the start time of the event should be visible on listings - `showEndDate` boolean — Whether the end date of the event should be visible on listings - `showEndTime` boolean — Whether the end time of the event should be visible on listings - `showTimeRangeInListing` boolean — Whether the end time of the event should be visible on listings - `showTimeRangeInTicket` boolean — Whether the time range of the event should be visible on ticket PDFs - `customCheckoutCSS` string — Custom CSS styling of the checkout of the event - `useCustomCheckoutBrand` boolean — Whether the checkout of the event should use custom brand - `customCheckoutBrand` string — A custom checkout brand of the event - `hideLogoInCheckout` boolean — Whether the logo should be hide on the checkout of the event - `customEventPageHTML` string — A custom HTML of the event page - `customEventPageCSS` string — A custom css styling of the event page - `customConfirmationPage` string — A custom css styling of the event page - `hideSeatmapInCheckout` boolean — Hides the seatmap from the ticket buyer even if seating ticket types are available - `dontSendBookingConfirmationSMS` boolean — Whether a sms should be sent for booking confirmation - `ticketSettings` object — The event ticket settings - `codeDisplay` 'BARCODE' | 'QRCODE' | 'HIDE', nullable — How the ticket code is displayed. Null inherits the seller setting. - `cancellationStrategy` 'disabled' | 'freeTicketsOnly' | 'withoutRefund' — Cancellation strategy of the ticket types - `revealingSettings` object — Barcode reveal settings of the event. - `enabled` 'ENABLED' | 'DISABLED', nullable - `beforeEvent` object - `target` string, nullable — The target of the relative date - `unit` 'hours' | 'days' | 'weeks' | 'months' | 'years', required — The unit in which the offset is specified - `offset` integer, required — The offset to the date - `transferSettings` object — Transfer settings of the ticket types - `mode` 'ALLOWED' | 'DISABLED' — Ticket transfer mode. - `expiresAfter` object — If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid. - `target` string, nullable — The target of the relative date - `unit` 'hours' | 'days' | 'weeks' | 'months' | 'years', required — The unit in which the offset is specified - `offset` integer, required — The offset to the date - `retransferMode` 'ALLOWED' | 'DISABLED' — Ticket retransfer mode. - `allowedUntil` object — If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible. - `target` string, nullable — The target of the relative date - `unit` 'hours' | 'days' | 'weeks' | 'months' | 'years', required — The unit in which the offset is specified - `offset` integer, required — The offset to the date - `hardTicketsMode` 'ALLOWED' | 'DISABLED' — If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed. - `seasonTicketMode` 'NO_RESTRICTION' | 'CHILDREN_ONLY' | 'GROUP_ONLY' — Restrict how season tickets can be transferred. - `useSeasonCardTemplate` boolean — Whether to use the season card template for individual tickets transferred from the season. - `upgradeSettings` object — Upgrade settings of the ticket types - `enabled` 'ENABLED' | 'DISABLED' — Whether ticket upgrade settings enabled. - `underShopMapping` object[] — Mapping to define the under shop in which a ticket upgrade will be performed. - `type` 'tag', required - `tag` string, required — The customer tag - `underShopId` string, required — The ID of the under shop. - `resellSettings` object — Resell settings - `enabled` 'ENABLED' | 'DISABLED', nullable — Whether resell is enabled - `resellerFeeFix` number, float, nullable — The fixed fee per ticket that the reseller pays - `resellerFeeVar` number, float, nullable — The variable fee per ticket that the reseller pays - `buyerFeeFix` number, float, nullable — The fixed fee per ticket that the buyer pays - `buyerFeeVar` number, float, nullable — The variable fee per ticket that the buyer pays - `offerCreationStart` object, nullable — A relative date specification of offers creation start. - `target` string, nullable — The target of the relative date - `unit` 'hours' | 'days' | 'weeks' | 'months' | 'years', required — The unit in which the offset is specified - `offset` integer, required — The offset to the date - `offerCreationEnd` object, nullable — A relative date specification of offers creation end. - `target` string, nullable — The target of the relative date - `unit` 'hours' | 'days' | 'weeks' | 'months' | 'years', required — The unit in which the offset is specified - `offset` integer, required — The offset to the date - `salesStart` object, nullable — A relative date specification of sales start. - `target` string, nullable — The target of the relative date - `unit` 'hours' | 'days' | 'weeks' | 'months' | 'years', required — The unit in which the offset is specified - `offset` integer, required — The offset to the date - `priceMarkup` number, float, nullable — The markup applied to the price of each ticket bought on the secondary market. - `cartAutomationMode` 'BLOCKED' | 'INDIVIDUAL', nullable — Controls whether tickets involved in cart automations can be resold. - `barcodeSettings` object — Barcode settings - `issueOfflineBarcodes` 'ENABLED' | 'DISABLED' — Whether offline barcodes are enabled - `childEventMapping` object[] — Child event mapping - `childEventId` string, required — The child event for this mapping - `ticketTypeMapping` object, required — Mapping between ticket types of the parent event and the child events - `valueShare` number, float, nullable — The percentage value of this child event from the value of the parent event - `seasonCardValueStrategy` 'childValue' | 'averagePerChild' | 'sharePerChild' — The strategy used to determine the value of a child event in the context of the parent event - `groups` object[] — An array of groups of ticket types of the event - `_id` string, required — The ID of of the ticket group of the event - `name` string, required — The name of the ticket group of the event - `tickets` string[], required — An array of ID's of ticket types of the event - `underShopId` string — The ID of the under shop of the event - `startingPrice` string — The starting price of the event - `showStartDate` boolean — Whether to show the start time of the event in listings or not - `showEndDate` boolean — Whether to show the end time of the event in listings or not - `showTimeRangeInListing` boolean — 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 - `timezone` string — Timezone of event - `category` string — - `subCategory` string — - `resell` object — Resell information - `saleActive` boolean — Whether the event has buying on the secondary market active. - `offerActive` boolean — Whether the event has selling on the secondary market active. - `fees` object — Fee information - `buyerFeeFix` number, float — The fixed fees charged for each ticket to the buyer. - `buyerFeeVar` number, float — The variable fees charged to the buyer. - `priceMarkup` number, float — The markup applied to the price of each ticket bought on the secondary market. - `attributes` object - `underShops` object[], required — List of under shops for POS context - `reservationSettings` object — Reservation settings for the POS context to determine if it is reservation only - `isDirectTicketSalesEnabled` boolean — Indicates whether direct ticket sales are enabled for the main event - `isMainEventAssignedToSalesChannel` boolean — Indicates that the event is assigned to the sales channel - `total` integer ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found --- [API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)