vivenu events API
The events API from vivenu — 21 operation(s) for events.
OpenAPI Specification
openapi: 3.0.3
info:
title: vivenu access-lists events API
description: vivenu API Documentation
version: 1.0.0
contact:
name: vivenu GmbH
url: https://vivenu.com
servers:
- url: https://vivenu.com
description: Production API
- url: https://vivenu.dev
description: Staging API
tags:
- name: events
paths:
/api/events:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: name
schema:
type: string
in: query
required: false
style: form
explode: true
- name: start
schema:
type: object
properties:
$gt:
description: value is greater than
type: string
format: date-time
$gte:
description: value is greater than or equal
type: string
format: date-time
$lt:
description: value is less than
type: string
format: date-time
$lte:
description: value is less than or equal
type: string
format: date-time
$eq:
description: value is equal
type: string
format: date-time
$ne:
description: value is not equal
type: string
format: date-time
additionalProperties: false
in: query
required: false
style: deepObject
explode: true
- name: end
schema:
type: object
properties:
$gt:
description: value is greater than
type: string
format: date-time
$gte:
description: value is greater than or equal
type: string
format: date-time
$lt:
description: value is less than
type: string
format: date-time
$lte:
description: value is less than or equal
type: string
format: date-time
$eq:
description: value is equal
type: string
format: date-time
$ne:
description: value is not equal
type: string
format: date-time
additionalProperties: false
in: query
required: false
style: deepObject
explode: true
- name: sortDir
schema:
default: '1'
type: string
enum:
- '1'
- '-1'
in: query
required: false
style: form
explode: true
- name: rootId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: type
schema:
anyOf:
- type: string
- type: array
items:
type: string
enum:
- SINGLE
- GROUP
- RECURRENCE
- ROOT
in: query
required: false
style: form
explode: true
- name: sellerId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: groupEventId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: salesChannelId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: childEvents
schema:
anyOf:
- type: string
- type: array
items:
type: string
in: query
required: false
style: form
explode: true
- name: subscriptionPlanId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: updatedAt
schema:
type: object
properties:
$gt:
description: value is greater than
type: string
format: date-time
$gte:
description: value is greater than or equal
type: string
format: date-time
$lt:
description: value is less than
type: string
format: date-time
$lte:
description: value is less than or equal
type: string
format: date-time
$eq:
description: value is equal
type: string
format: date-time
$ne:
description: value is not equal
type: string
format: date-time
additionalProperties: false
in: query
required: false
style: deepObject
explode: true
- name: createdAt
schema:
type: object
properties:
$gt:
description: value is greater than
type: string
format: date-time
$gte:
description: value is greater than or equal
type: string
format: date-time
$lt:
description: value is less than
type: string
format: date-time
$lte:
description: value is less than or equal
type: string
format: date-time
$eq:
description: value is equal
type: string
format: date-time
$ne:
description: value is not equal
type: string
format: date-time
additionalProperties: false
in: query
required: false
style: deepObject
explode: true
- name: top
schema:
default: 25
description: A limit on the number of objects to be returned. Can range between 1 and 1000.
type: integer
minimum: 1
maximum: 1000
description: A limit on the number of objects to be returned. Can range between 1 and 1000.
in: query
required: true
style: form
explode: true
- name: skip
schema:
default: 0
description: The number of objects to skip for the requested result
type: integer
minimum: 0
maximum: 9007199254740991
description: The number of objects to skip for the requested result
in: query
required: true
style: form
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Events_GetAllEvents_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- events
description: Get all Events
operationId: events/list
post:
security:
- jwt: []
- apikey: []
parameters: []
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/EventResource'
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Events_CreateAnEvent'
tags:
- events
description: Create an Event
operationId: events/create
/api/events/rich:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: name
schema:
type: string
in: query
required: false
style: form
explode: true
- name: start
schema:
type: object
properties:
$gt:
description: value is greater than
type: string
format: date-time
$gte:
description: value is greater than or equal
type: string
format: date-time
$lt:
description: value is less than
type: string
format: date-time
$lte:
description: value is less than or equal
type: string
format: date-time
$eq:
description: value is equal
type: string
format: date-time
$ne:
description: value is not equal
type: string
format: date-time
additionalProperties: false
in: query
required: false
style: deepObject
explode: true
- name: end
schema:
type: object
properties:
$gt:
description: value is greater than
type: string
format: date-time
$gte:
description: value is greater than or equal
type: string
format: date-time
$lt:
description: value is less than
type: string
format: date-time
$lte:
description: value is less than or equal
type: string
format: date-time
$eq:
description: value is equal
type: string
format: date-time
$ne:
description: value is not equal
type: string
format: date-time
additionalProperties: false
in: query
required: false
style: deepObject
explode: true
- name: sortDir
schema:
default: '1'
type: string
enum:
- '1'
- '-1'
in: query
required: false
style: form
explode: true
- name: rootId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: type
schema:
anyOf:
- type: string
- type: array
items:
type: string
enum:
- SINGLE
- GROUP
- RECURRENCE
- ROOT
in: query
required: false
style: form
explode: true
- name: sellerId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: groupEventId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: salesChannelId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: childEvents
schema:
anyOf:
- type: string
- type: array
items:
type: string
in: query
required: false
style: form
explode: true
- name: subscriptionPlanId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: updatedAt
schema:
type: object
properties:
$gt:
description: value is greater than
type: string
format: date-time
$gte:
description: value is greater than or equal
type: string
format: date-time
$lt:
description: value is less than
type: string
format: date-time
$lte:
description: value is less than or equal
type: string
format: date-time
$eq:
description: value is equal
type: string
format: date-time
$ne:
description: value is not equal
type: string
format: date-time
additionalProperties: false
in: query
required: false
style: deepObject
explode: true
- name: createdAt
schema:
type: object
properties:
$gt:
description: value is greater than
type: string
format: date-time
$gte:
description: value is greater than or equal
type: string
format: date-time
$lt:
description: value is less than
type: string
format: date-time
$lte:
description: value is less than or equal
type: string
format: date-time
$eq:
description: value is equal
type: string
format: date-time
$ne:
description: value is not equal
type: string
format: date-time
additionalProperties: false
in: query
required: false
style: deepObject
explode: true
- name: top
schema:
default: 25
description: A limit on the number of objects to be returned. Can range between 1 and 1000.
type: integer
minimum: 1
maximum: 1000
description: A limit on the number of objects to be returned. Can range between 1 and 1000.
in: query
required: true
style: form
explode: true
- name: skip
schema:
default: 0
description: The number of objects to skip for the requested result
type: integer
minimum: 0
maximum: 9007199254740991
description: The number of objects to skip for the requested result
in: query
required: true
style: form
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Events_GetAllEventsRich_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- events
description: Get all Events Rich
deprecated: true
operationId: get_all_events_rich
/api/events/{id}:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EventResource'
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- events
description: Get an Event
operationId: events/get
put:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EventResource'
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PUT_Events_UpdateAnEvent'
tags:
- events
description: Update an Event
operationId: events/update
delete:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EventResource'
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- events
description: Delete an Event
operationId: events/delete
/api/stats/reports:
get:
security:
- jwt: []
parameters:
- name: pos
required: false
schema:
type: boolean
metas: {}
in: query
style: form
explode: true
responses:
'200':
description: OK
tags:
- events
description: Get Event Reports
operationId: get_event_reports
/api/events/info/{id}:
get:
parameters:
- name: web
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: underShop
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: posOperationMode
required: false
schema:
type: string
enum:
- OPERATOR
- KIOSK
metas: {}
in: query
style: form
explode: true
- name: pos
required: false
schema:
type: boolean
metas: {}
in: query
style: form
explode: true
- name: channel
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: locale
required: false
schema:
type: string
description: Get the info for a specific language
metas: {}
in: query
style: form
explode: true
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EventInfoResource'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- events
description: Get Event info
operationId: get_event_info
/api/events/public/listings:
get:
parameters:
- name: top
required: false
schema:
type: number
format: float
metas: {}
in: query
style: form
explode: true
- name: skip
required: false
schema:
type: number
format: float
metas: {}
in: query
style: form
explode: true
- name: startMin
required: false
schema:
type: string
format: date-time
metas: {}
in: query
style: form
explode: true
- name: startMax
required: false
schema:
type: string
format: date-time
metas: {}
in: query
style: form
explode: true
- name: endMin
required: false
schema:
type: string
format: date-time
metas: {}
in: query
style: form
explode: true
- name: endMax
required: false
schema:
type: string
format: date-time
metas: {}
in: query
style: form
explode: true
- name: sectionURL
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: sellerId
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: orgId
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: rootId
required: false
schema:
oneOf:
- type: array
items:
type: string
metas: {}
minItems: 0
metas: {}
- type: string
metas: {}
metas: {}
in: query
style: form
explode: true
- name: groupEventId
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: eventIds
required: false
schema:
type: array
items:
type: string
metas: {}
minItems: 0
metas: {}
in: query
style: form
explode: true
- name: sortBy
required: false
schema:
type: string
enum:
- start
default: start
metas: {}
in: query
style: form
explode: true
- name: sortOrder
required: false
schema:
type: string
enum:
- ASC
- DESC
default: ASC
metas: {}
in: query
style: form
explode: true
- name: visibleInListing
required: false
schema:
type: boolean
enum:
- true
metas: {}
in: query
style: form
explode: true
- name: showStartDate
required: false
schema:
type: boolean
metas: {}
in: query
style: form
explode: true
- name: locale
required: false
schema:
type: string
description: Get the info for a specific language
metas: {}
in: query
style: form
explode: true
- name: eventType
required: false
schema:
type: string
enum:
- SINGLE
- GROUP
- RECURRENCE
metas: {}
in: query
style: form
explode: true
- name: underShopId
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: attributes
required: false
schema:
type: object
metas: {}
in: query
style: deepObject
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Events_GetPublicListingEvents_200_response'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- events
description: Get public listing events
operationId: get_public_listing_events
/api/events/{id}/parents:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Events_GetEventParents_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- events
description: Get Event parents
operationId: get_event_parents
/api/events/{id}/parent:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EventResource'
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- events
description: Get Event parent
deprecated: true
operationId: get_event_parent
/api/events/{eventId}/recommendations:
get:
parameters:
- name: locale
required: false
schema:
type: string
description: Get the info for a specific language
metas: {}
in: query
style: form
explode: true
- name: eventId
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EventResource'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- events
description: Get more Events
operationId: get_more_events
/api/public/events/{id}:
get:
parameters:
- name: locale
required: false
schema:
type: string
description: Get the event for a specific language
metas: {}
in: query
style: form
explode: true
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PublicEventResource'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- events
description: Get Public Event
operationId: get_public_event
/api/stats/events/status:
get:
security:
- jwt: []
parameters:
- name: top
required: false
schema:
type: number
format: float
metas: {}
in: query
style: form
explode: true
- name: skip
required: false
schema:
type: number
format: float
metas: {}
in: query
style: form
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Events_GetEventsWithStatus_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- events
description: Get Events with status
operationId: get_events_with_status
/api/events/public/listings/{id}:
get:
parameters:
- name: locale
required: false
schema:
type: string
description: Get the info for a specific language
metas: {}
in: query
style: form
explode: true
- name: underShopId
required: false
schema:
type: string
description: Get the info for a specific shop
metas: {}
in: query
style: form
explode: true
- name: id
schema:
type: string
required: true
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Events_GetPublicListingEvent_200_response'
'400':
description: Bad Request
tags:
- events
description: Get public listing event
operationId: get_public_listing_event
/api/public/events/{id}/offers:
get:
parameters:
- name: locale
required: false
schema:
type: string
description: Get the info for a specific language
metas: {}
in: query
style: form
explode: true
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Events_GetOffersForAnEvent_200_response'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- events
description: Get offers for an event
operationId: events/getOffers
/api/public/events/{id}/availabilities:
get:
parameters:
- name: shopId
required: false
schema:
type: string
description: The shop id
metas: {}
in: query
style: form
explode: true
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- events
description: Get Event Availabilities
operationId: get_event_availabilities
/api/public/events/{id}/shop:
get:
parameters:
- name: locale
required: false
schema:
type: string
description: Get the shop for a specific language
metas: {}
in: query
style: form
explode: true
- name: shopId
required: false
schema:
type: string
description: The shop id
metas: {}
in: query
style: form
explode: true
- name: channelId
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: pos
required: false
schema:
type: boolean
metas: {}
in: query
style: form
explode: true
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
'400':
description: Bad Request
tags:
- events
description: Get Public Shop
operationId: get_public_shop
/api/stats/events/{id}/status:
get:
security:
- jwt: []
parameters:
- name: start
required: false
schema:
type: string
format: date-time
metas: {}
in: query
style: form
explode: true
- name: end
required: false
schema:
type: string
format: date-time
metas: {}
in: query
style: form
explode: true
- name: posId
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: id
schema:
type: string
required: true
in: path
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- events
description: Get Event Status
deprecated: true
operationId: get_event_status
/api/events/duplicate:
post:
security:
- jwt: []
- apikey: []
parameters: []
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/EventResource'
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Events_DuplicateAnEvent'
tags:
- events
description: Duplicate an Event
operationId: duplicate_an_event
/api/events/{id}/recurrences:
post:
security:
- jwt: []
-
# --- truncated at 32 KB (438 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vivenu/refs/heads/main/openapi/vivenu-events-api-openapi.yml