vivenu api API
The api API from vivenu — 449 operation(s) for api.
vivenu api API is one of 73 APIs that vivenu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 585 operations across 449 paths, and defines 454 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against 2 base URLs: https://vivenu.com, https://vivenu.dev.
585 operations
449 paths
454 schemas
26 DELETE292 GET7 PATCH196 POST64 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
vivenu api API declares
4 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (jwt).
An API key is passed in the header as Authorization (apikey).
It accepts HTTP bearer tokens (JWT) (customer-jwt).
An API key is passed in the header as Authorization (orgApiKey).
Paths & Operations 585
Across 449 paths, the API surfaces 585 operations — 26 DELETE, 292 GET, 7 PATCH, 196 POST, 64 PUT. Each is listed below with its method, path, parameters, and response codes.
api 585
GET
/api/access-lists
Get Access Lists
POST
/api/access-lists
Create an Access List
GET
/api/accessusers
Get all Access Users
POST
/api/accessusers
Create an Access User
GET
/api/attributes
Get All Attributes
POST
/api/attributes
Create an Attribute
GET
/api/bundles
Get all Bundles
POST
/api/bundles
Create a Bundle
GET
/api/cancellations
Get all cancellations
GET
/api/channels
Get all Channels
POST
/api/channels
Create a Channel
GET
/api/checkouts
Get all checkouts
POST
/api/checkouts
Create a checkout
GET
/api/credit-notes
List Credit Notes
GET
/api/data-fields
Get all Data Fields
POST
/api/data-fields
Create a Data Field
GET
/api/disputes
Get disputes
GET
/api/distributors
Get distributor for sales channel
GET
/api/document-templates
Get all Document Templates
POST
/api/document-templates
Create a Document Template
GET
/api/entitlements
List entitlements
POST
/api/entitlements
Create a new entitlement
GET
/api/event-series
Get all event series
POST
/api/event-series
Create an event series
GET
/api/events
Get all Events
POST
/api/events
Create an Event
GET
/api/fee-schemes
Get all fee schemes
POST
/api/fee-schemes
Create a fee scheme
GET
/api/image
Get all Images
POST
/api/image
Create an Image
GET
/api/invoices
Get All Invoices
POST
/api/invoices
Create Invoice for Transaction
GET
/api/jobs
Get all jobs
POST
/api/jobs
Create an job
GET
/api/keys
Get All API Keys
POST
/api/keys
Create an API Key
GET
/api/notifications
Get all notifications
GET
/api/organizations
Get all Organizations
POST
/api/organizations
Create an Organization
GET
/api/packages
GET
/api/payments
Get Payments
GET
/api/perks
List all Perks
POST
/api/perks
Create a Perk
GET
/api/pos
Get all POS
POST
/api/pos
Create a POS
GET
/api/posinfo
Get all POS Infos
GET
/api/price-tables
Get all Price Tables
POST
/api/price-tables
Create a Price Table
GET
/api/products
Get all Products
POST
/api/products
Create a Product
GET
/api/purchaseintents
Get all PurchaseIntents
POST
/api/purchaseintents
Create a PurchaseIntent
GET
/api/rebookings
Get All Rebookings
GET
/api/reports
Get Report
GET
/api/sales-channels
Get all sales channels
POST
/api/sales-channels
Create a sales channel
GET
/api/scan-groups
Get All Scan Groups
POST
/api/scan-groups
Create a Scan Group
GET
/api/scan-zones
Get Scan Zones
POST
/api/scan-zones
Create a Scan Zone
GET
/api/sellers
Get all Sellers
POST
/api/sellers
Create a Seller
GET
/api/subscriptions
Get all Subscriptions
GET
/api/supports
Get all supports tickets
GET
/api/ticket-transfers
Get All Ticket Transfers
POST
/api/ticket-transfers
Create Ticket Transfer
GET
/api/tickets
Get all Tickets
GET
/api/transactions
Get All Transactions
GET
/api/users
Get all Users
GET
/api/vouchers
Get all Vouchers
POST
/api/vouchers
Create a Voucher
GET
/api/webhooks
Get all webhooks
POST
/api/webhooks
Create a new webhook
GET
/api/access-lists/{id}
Get an Access List
PUT
/api/access-lists/{id}
Update an Access List
DELETE
/api/access-lists/{id}
Delete an Access List
GET
/api/accessusers/events
Get all accessible Events
GET
/api/accessusers/me
Get associated AccessUser info
GET
/api/accessusers/seller
Get associated Seller Id
GET
/api/attributes/{id}
Get an Attribute
PUT
/api/attributes/{id}
Update an Attribute
DELETE
/api/attributes/{id}
Delete an Attribute
GET
/api/bundles/{id}
Get a Bundle
PUT
/api/bundles/{id}
Update a Bundle
GET
/api/channels/{id}
Get Channel
PUT
/api/channels/{id}
Update a Channel
GET
/api/checkout/{id}
Get a Checkout
PUT
/api/checkout/{id}
Update a checkout
GET
/api/checkouts/{id}
Get checkout by id
GET
/api/coupon/rich
Get all Coupons
GET
/api/coupon/series
Get all coupon series
POST
/api/coupon/series
Create coupon series
GET
/api/coupon/{id}
Get a Coupon
PUT
/api/coupon/{id}
Update a Coupon
GET
/api/customers/me
Get current customer
POST
/api/customers/me
Update current customer
GET
/api/customers/payment-methods
Get customer payment methods
GET
/api/customers/rich
Get all Customers
GET
/api/customers/tags
Get all Customer tags
GET
/api/customers/transfers
Get All Transfers
GET
/api/customers/{id}
Get Customer
PUT
/api/customers/{id}
Update Customer
DELETE
/api/customers/{id}
Delete Customer
GET
/api/data-fields/resolve
Get all Data Fields by reference
GET
/api/data-fields/{id}
Get a Data Field
PUT
/api/data-fields/{id}
Update a Data Field
GET
/api/distribution/events
Get all events for a seller.
GET
/api/distribution/sellers
Get all sellers.
GET
/api/distributors/{id}
Get a distributor
GET
/api/document-templates/print
Get Document Templates
GET
/api/document-templates/{id}
Get a Document Template
PUT
/api/document-templates/{id}
Update a Document Template
DELETE
/api/document-templates/{id}
Delete a Document Template
GET
/api/entitlements/{id}
Get an entitlement by ID
PUT
/api/entitlements/{id}
Update an entitlement
GET
/api/event-series/{id}
Get an event series
PUT
/api/event-series/{id}
Update an event series
DELETE
/api/event-series/{id}
Delete an event series
GET
/api/events/richdeprecated
Get all Events Rich
GET
/api/events/{id}
Get an Event
PUT
/api/events/{id}
Update an Event
DELETE
/api/events/{id}
Delete an Event
GET
/api/fee-schemes/{id}
Get a fee scheme
PUT
/api/fee-schemes/{id}
Update a fee scheme
GET
/api/fundraise/campaigns
Get All Campaigns
POST
/api/fundraise/campaigns
Create a Campaign
GET
/api/fundraise/funds
Get All Funds
POST
/api/fundraise/funds
Create a Fund
GET
/api/invoices/{id}
Get an Invoice
PUT
/api/invoices/{id}
Update an Invoice
GET
/api/jobs/schedules
Get All Scheduled Jobs
POST
/api/jobs/schedules
Create a Scheduled Job
GET
/api/jobs/{id}
Get an job
GET
/api/keys/info
Get Information about the used API Key
GET
/api/keys/{id}
Get an API Key
PUT
/api/keys/{id}
Update an API Key
GET
/api/marketing/campaigns
Get All Marketing Campaigns
POST
/api/marketing/campaigns
Create a Marketing Campaign
GET
/api/marketing/short-links
Get All Short Links
POST
/api/marketing/short-links
Create a Short Link
GET
/api/notifications/preferences
Get notification settings for the authenticated user
PATCH
/api/notifications/preferences
Update notification settings for the authenticated user
GET
/api/organizations/{id}
Get an Organization
PUT
/api/organizations/{id}
Update an Organization
GET
/api/packages/configs
POST
/api/packages/configs
GET
/api/packages/{id}
GET
/api/payments/chargebacks
Get all chargebacks
GET
/api/payments/gateways
Get all Payment Gateways
POST
/api/payments/gateways
Create a Payment Gateway
GET
/api/payments/plans
List Payment Plans
GET
/api/payments/refunds
Get all refunds
GET
/api/payments/requests
Get Payment Requests
POST
/api/payments/requests
Create a Payment Request
GET
/api/payments/strategies
Get Payment Strategies
POST
/api/payments/strategies
Create a Payment Strategy
GET
/api/payments/{id}
Get a Payment
GET
/api/perks/{id}
Get a Perk by ID
PUT
/api/perks/{id}
Update a Perk
DELETE
/api/perks/{id}
Delete a Perk
GET
/api/pos/{id}
Get POS
PUT
/api/pos/{id}
Update POS
GET
/api/posinfo/{id}
Get POS Info
GET
/api/price-tables/{id}
Get a Price Table
PUT
/api/price-tables/{id}
Update a Price Table
GET
/api/printjob/count
Count Print jobs
GET
/api/printjob/rich
Get all Print jobs
GET
/api/printjob/{id}
Get a Print job
PUT
/api/printjob/{id}
Update a Print job
GET
/api/products/categories
Get all Product Categories
POST
/api/products/categories
Create a Product Category
GET
/api/products/rich
Get all Products
GET
/api/products/{id}
Get a Product
PUT
/api/products/{id}
Update a Product
DELETE
/api/products/{id}
Delete a Product
GET
/api/public/ticket-transfers
Get Public Ticket Transfers
GET
/api/purchaseintents/search
Search a PurchaseIntent
GET
/api/purchaseintents/strategies
Get all PurchaseIntent Strategies
POST
/api/purchaseintents/strategies
Create PurchaseIntent Strategies
GET
/api/purchaseintents/{id}
Get a PurchaseIntent
PATCH
/api/purchaseintents/{id}
Update a PurchaseIntent
GET
/api/rebookings/strategies
POST
/api/rebookings/strategies
GET
/api/resell/offers
List offers
POST
/api/resell/offers
Create an offer
GET
/api/sales-channels/groups
Get all sales channel groups
POST
/api/sales-channels/groups
Create a sales channel group
GET
/api/sales-channels/{id}
Get a SalesChannel
PUT
/api/sales-channels/{id}
Update a sales channel
GET
/api/scan-groups/{id}
Get a Scan Group
PUT
/api/scan-groups/{id}
Update a Scan Group
DELETE
/api/scan-groups/{id}
Delete a Scan Group
GET
/api/scan-zones/{id}
Get a Scan Zone
PUT
/api/scan-zones/{id}
Update a Scan Zone
GET
/api/sellers/me
Get Seller by user
GET
/api/sellers/{id}
Get a Seller
PUT
/api/sellers/{id}
Update a Seller
GET
/api/stats/avgcartdeprecated
Get Transaction avg Cart
GET
/api/stats/charges
Get Charges per time scope
GET
/api/stats/customersdeprecated
Get Customers per time scope
GET
/api/stats/dayhoursdeprecated
Get Transaction Day Hours
GET
/api/stats/discounts
Get applied Discounts
GET
/api/stats/discountsusage
Get discount usage
GET
/api/stats/money
Get Money per time scope
GET
/api/stats/paymentmethoddeprecated
Get Transaction Payment Method
GET
/api/stats/posdiscounts
Get applied POS Discounts
GET
/api/stats/posdiscountsusage
Get applied pos discount
GET
/api/stats/reports
Get Event Reports
GET
/api/stats/status
Get Transaction States
GET
/api/stats/tickets
Get Tickets per time scope
GET
/api/subscriptions/cycles
Get all Subscription Cycles
POST
/api/subscriptions/cycles
Create a Subscription Cycle
GET
/api/subscriptions/plans
Get all Subscription Plans
POST
/api/subscriptions/plans
Create a subscription Plan
GET
/api/subscriptions/{id}
Get a Subscription
PUT
/api/subscriptions/{id}
Update a Subscription
GET
/api/support/status
Count unfinished Support requests
GET
/api/support/{id}
Get a support ticket
PUT
/api/support/{id}
Send a message
GET
/api/supports/{id}
Get support ticket
PATCH
/api/supports/{id}
Patch a support ticket
PUT
/api/supports/{id}
Update a support ticket
DELETE
/api/supports/{id}
Delete support ticket
GET
/api/ticket-transfers/{id}
Get a Ticket Transfer
GET
/api/tickets/{id}
Get a Ticket
PUT
/api/tickets/{id}
Update a Ticket
GET
/api/transactions/richdeprecated
Get all Transactions rich
GET
/api/transactions/{id}
Get a Transaction
GET
/api/users/info
Get my User info
GET
/api/users/rich
Get Users rich
GET
/api/users/sellers
Get all Sellers of a User
GET
/api/vouchers/richdeprecated
Get all Vouchers
GET
/api/vouchers/{id}
Get Voucher by id
PUT
/api/vouchers/{id}
Update a Voucher
GET
/api/access-lists/{listId}/entries
Get all Access List Entries
POST
/api/access-lists/{listId}/entries
Create an Access List Entry
GET
/api/accessusers/tickets/{barcode}
Get Ticket with barcode
GET
/api/accessusers/{eventId}/tickets
Get Tickets for an Event
GET
/api/action-notification/{type}/{id}
Get Action Notification Subscription
POST
/api/action-notification/{type}/{id}
Update Action Notification Subscription
GET
/api/channels/{code}/info
Get Channel Info by code
GET
/api/checkout/transaction/{id}deprecated
Get a Transaction
GET
/api/checkout/{id}/tickets
Get all tickets for a checkout
GET
/api/checkout/{id}/detailsform
Get details form
GET
/api/coupon/series/{id}
Get a coupon series
PUT
/api/coupon/series/{id}
Update coupon series
GET
/api/coupon/{code}/info
Get Coupon or Voucher by code
GET
/api/customers/me/payment-methods
Get payment methods for logged in customer
POST
/api/customers/me/payment-methods
Create a payment method
GET
/api/customers/me/payment-plans
Get payment plans of customer
GET
/api/customers/me/purchaseintents
Get PurchaseIntents of customer
GET
/api/customers/me/resell-offers
Get Resell Offers of Customer
GET
/api/customers/me/shops
Get undershops of customer
GET
/api/customers/me/subscriptions
Get subscriptions of customer
GET
/api/customers/me/ticket-transfers
Get Ticket Transfers of Customer
GET
/api/customers/me/tickets
Get tickets of customer
GET
/api/customers/me/transactions
Get transactions of customer
GET
/api/customers/password-reset/{token}
Reset password
PUT
/api/customers/password-reset/{token}
Set a new password
GET
/api/customers/transfers/{id}
Get Transfer
PUT
/api/customers/transfers/{id}
Update a Transfer
GET
/api/customers/{id}/balance
Get Customer Balance
GET
/api/customers/{id}/payment-methods
Get payment methods for customer
POST
/api/customers/{id}/payment-methods
Create a customer payment method
GET
/api/distribution/checkout/{id}
Get a checkout.
GET
/api/distribution/events/{id}
Get an event for a seller.
GET
/api/events/info/{id}
Get Event info
GET
/api/events/public/listings
Get public listing events
GET
/api/events/{id}/parents
Get Event parents
GET
/api/events/{id}/parentdeprecated
Get Event parent
GET
/api/events/{eventId}/recommendations
Get more Events
GET
/api/fundraise/campaigns/{id}
Get a Campaign
PUT
/api/fundraise/campaigns/{id}
Update a Campaign
GET
/api/fundraise/donations/{id}
Get a Donation
GET
/api/fundraise/funds/{id}
Get a Fund
PUT
/api/fundraise/funds/{id}
Update a Fund
GET
/api/fundraise/pledges/{id}
Get a Pledge
GET
/api/invoices/trans/{transactionId}deprecated
Get Invoice for Transaction (deprecated - use GET /invoices with the transactionId query parameter instead)
POST
/api/invoices/trans/{transactionId}deprecated
Create Invoice for Transaction (deprecated - use POST /invoices with query parameter transactionId instead)
GET
/api/jobs/schedules/{id}
Get a Scheduled Job
PUT
/api/jobs/schedules/{id}
Update a Scheduled Job
DELETE
/api/jobs/schedules/{id}
Delete a Scheduled Job
GET
/api/marketing/campaigns/{id}
Get a Marketing Campaign
PUT
/api/marketing/campaigns/{id}
Update a Marketing Campaign
DELETE
/api/marketing/campaigns/{id}
Delete a Marketing Campaign
GET
/api/organizations/{id}/info
Get an Organizations public info
GET
/api/packages/configs/{id}
PUT
/api/packages/configs/{id}
GET
/api/payments/chargebacks/{id}
Get a chargeback
GET
/api/payments/gateways/{id}
Get a Payment Gateway
PUT
/api/payments/gateways/{id}
Update a Payment Gateway
GET
/api/payments/plans/{id}
Get a Payment Plan
PUT
/api/payments/plans/{id}
Update a Payment Plan
GET
/api/payments/refunds/{id}
Get a refund
GET
/api/payments/requests/{id}
Get a Payment Request
PUT
/api/payments/requests/{id}
Update a Payment Request
GET
/api/payments/strategies/{id}
Get a Payment Strategy
PUT
/api/payments/strategies/{id}
Update a Payment Strategy
GET
/api/pos/payments/gateways
Get the IDs and the types of all active POS payment gateways
GET
/api/pos/{id}/scannable
Get scannable information for a code
GET
/api/pos/{id}/xreport
Get X report
GET
/api/pos/{id}/status
Get POS Status
GET
/api/pos/{id}/sessions
Get POS sessions
GET
/api/pos/{id}/fiscalization-info
Get POS fiscalization info
GET
/api/pos/{id}/logs
Get POS journal logs
GET
/api/pos/{id}/events
Get pos events
GET
/api/products/categories/{id}
Get a Product Category
PUT
/api/products/categories/{id}
Update a Product Category
GET
/api/products/streams/rich
Get all Product Streams
GET
/api/products/streams/{id}
Get a Product Stream
PUT
/api/products/streams/{id}
Update a Product Stream
DELETE
/api/products/streams/{id}
Delete a Product Stream
GET
/api/public/document-templates/{id}
Get the public Document Template
GET
/api/public/events/{id}
Get Public Event
GET
/api/public/invoices/info
Get Public Invoice for Transaction
GET
/api/public/products/{id}
Get a Public Product
GET
/api/public/purchaseintents/{id}
Get public PurchaseIntent
GET
/api/public/rebookings/info
GET
/api/public/resell/listings
Get public resell listings
GET
/api/public/subscriptions/{id}
Get a public Subscription
PUT
/api/public/subscriptions/{id}
Update a Subscription
GET
/api/public/transactions/{id}
Get transaction's public info
GET
/api/purchaseintents/strategies/{id}
Get a PurchaseIntent Strategy
PUT
/api/purchaseintents/strategies/{id}
Update a PurchaseIntent Strategy
GET
/api/rebookings/strategies/{id}
PUT
/api/rebookings/strategies/{id}
DELETE
/api/rebookings/strategies/{id}
GET
/api/resell/offers/{id}
Get offer by id
GET
/api/sales-channels/groups/{id}
Get a SalesChannelGroup
PUT
/api/sales-channels/groups/{id}
Update a sales channel group
GET
/api/sellers/info/{id}
Get Seller info
GET
/api/sellers/{id}/vitals
Get Seller Vitals
GET
/api/stats/checkouts/countByStatusdeprecated
Aggregate checkouts by status
GET
/api/stats/events/status
Get Events with status
GET
/api/stats/reports/billing
Get Event Billing Report
GET
/api/stats/reports/corrections
Get Corrections Billing Report
GET
/api/stats/reports/fees
Get Fee Report
GET
/api/stats/reports/membership-billing
Get Membership Billing Report
GET
/api/stats/reports/multi-billing
Get Multi Event Billing Report
GET
/api/stats/transaction/reports
Get Transaction reports
GET
/api/stats/transactions/extra-fields
Get Transaction Extra Fields
GET
/api/stats/transactions/location
Get Transaction Locations
GET
/api/subscriptions/cycles/{id}
Get a Subscription Cycle
PUT
/api/subscriptions/cycles/{id}
Update a Subscription Cycle
GET
/api/subscriptions/plans/{id}
Get a Subscription Plan
PUT
/api/subscriptions/plans/{id}
Update a subscription Plan
GET
/api/subscriptions/{id}/cycles
Get all Subscription Cycles
GET
/api/supports/{id}/context
Get support context
GET
/api/third/exchange/validate
Validate a ticket by its barcode
GET
/api/third/queue-slips/checkouts
Preview the checkout filter
POST
/api/third/queue-slips/checkouts
Create checkout queue slip populator job
GET
/api/third/queue-slips/tickets
Preview the ticket filter
POST
/api/third/queue-slips/tickets
Create ticket queue slip populator job
GET
/api/third/queue-slips/vouchers
Preview the voucher filter
POST
/api/third/queue-slips/vouchers
Create voucher queue slip populator job
GET
/api/ticket-transfers/{id}/{secret}
Get Public Ticket Transfer
GET
/api/tickets/batch/{batchId}
Get Tickets of Batch
GET
/api/tickets/{id}/{secret}
Get Ticket information
GET
/api/transaction/{id}/checkout
Get transactions checkout
GET
/api/transactions/{id}/tickets
Get all Transaction Tickets
GET
/api/transactions/{id}/cancellations
Get Transaction cancellation info
POST
/api/transactions/{id}/cancellations
Create a Transaction cancellation
GET
/api/users/info/{id}
Get User info
GET
/api/users/password-reset/{token}
Check if password reset exists
PUT
/api/users/password-reset/{token}
Set password after reset
GET
/api/users/{userId}/devices
Get user devices
GET
/api/vouchers/{id}/transactions
Get Voucher Transactions by id
GET
/api/access-lists/entries/{externalCode}/ticket
Get an Access List Entry's Ticket
GET
/api/access-lists/{listId}/entries/{id}
Get an Access List Entry
PUT
/api/access-lists/{listId}/entries/{id}
Update an Access List Entry
DELETE
/api/access-lists/{listId}/entries/{id}
Delete an Access List Entry
GET
/api/accessusers/tickets/v2/{eventId}
Get Tickets for an Event v2
GET
/api/auth/sso/{ssoId}/authorize
Get redirected to SSO provider
GET
/api/customers/me/payment-methods/{id}
Get payment method for logged in customer
GET
/api/customers/{customerId}/payment-methods/{id}
Get payment method for customer
GET
/api/distribution/events/{id}/availabilities
Get the availabilities for an event.
GET
/api/events/public/listings/{id}
Get public listing event
GET
/api/invoices/{transactionId}/info/{secret}deprecated
Get Public Invoice for Transaction (deprecated - use GET /public/invoices/info with query parameters transactionId and secret instead)
GET
/api/pos/{id}/export/orderdiscounts
Export POS order discounts
GET
/api/pos/{id}/export/orders
Export POS orders
GET
/api/pos/{id}/export/journallogs
Export POS journal logs
GET
/api/pos/{id}/zreport/{reportId}
Get Z report
GET
/api/pos/{id}/collect-checkout/{checkoutId}
Collect Checkout Data
GET
/api/pos/{id}/export/cancellations
Export POS cancellations
GET
/api/pos/{id}/export/orderitems
Export POS order items
GET
/api/products/streams/{id}/products
Get a Product Stream's Products
GET
/api/public/credit-notes/{id}/info
Get Credit Note Info
GET
/api/public/events/{id}/offers
Get offers for an event
GET
/api/public/events/{id}/availabilities
Get Event Availabilities
GET
/api/public/events/{id}/shop
Get Public Shop
GET
/api/public/invoices/{id}/info
Get Public Invoice
GET
/api/public/packages/configs/{slug}
GET
/api/public/payments/plans/{id}
Get a Public Payment Plan
PUT
/api/public/payments/plans/{id}
Update a Public Payment Plan
GET
/api/public/payments/strategies/{id}
Get Public Payment Strategy
GET
/api/public/purchaseintents/{id}/tickets
Get public PurchaseIntent tickets
GET
/api/public/rebookings/strategies/{id}
GET
/api/public/sellers/{id}/payment-methods
Get Sellers Payment Methods
GET
/api/public/subscriptions/plans/{id}
Get a Public Subscription Plan
GET
/api/public/subscriptions/{id}/tickets
Get all tickets for a Subscription
GET
/api/public/tickets/upgrades/info
Get ticket upgrade info
GET
/api/public/tickets/{id}/return-info
Return a Ticket
GET
/api/public/tickets/{id}/transaction
Get transaction of a ticket
GET
/api/public/transactions/{id}/tickets
Get transaction's public tickets
GET
/api/public/transactions/{id}/payment-plan
Get a payment plan's public information based on the transaction
GET
/api/resell/offers/{id}/listing
Get listing of offer
GET
/api/resell/ticket/{id}/status
Get internal ticket resell status
GET
/api/stats/events/{id}/statusdeprecated
Get Event Status
GET
/api/stats/reports/billing/seller
Get Seller Billing Report
GET
/api/third/exchange/validate/tickets
Receive the ticket exchange payload for multiple tickets
GET
/api/tickets/{id}/print/{secret}
Get Ticket Print Data
GET
/api/transaction/{id}/print/{secret}
Get Transaction print data
GET
/api/vouchers/{id}/{code}/info
Get Voucher by id and code
GET
/api/public/packages/configs/{slug}/info
GET
/api/public/resell/ticket/{id}/status
Get public ticket resell status
GET
/api/third/exchange/listings/{id}/validate
Validates the active listing for multiple tickets
GET
/api/distribution/events/{eventId}/availabilities/{availabilityId}/seating-groups
Get seating groups for an event.
GET
/api/public/sellers/{sellerId}/marketing/short-links/{code}
Public Get Sellers Short Link
GET
/api/distribution/events/{eventId}/availabilities/{availabilityId}/seating-groups/{groupId}
Get the state for a seating group.
POST
/api/checkout
Create a Checkout
POST
/api/coupon
Create a Coupon
POST
/api/customers
Create Customer
POST
/api/support
Create a support ticket
POST
/api/upload
POST
/api/auth/exchange-token
Create an exchange token
POST
/api/auth/token
Exchange a token
POST
/api/coupon/generate
Generate coupons for coupon series
POST
/api/customers/login
Login customer
POST
/api/customers/password-reset
Request a password reset mail
POST
/api/customers/register
Register as a customer
POST
/api/distribution/checkout
Create a checkout.
POST
/api/events/duplicate
Duplicate an Event
POST
/api/fundraise/donations
Create a Donation
POST
/api/fundraise/pledges
Create a Pledge
POST
/api/insurance/offers
Get insurance offers for a Checkout
POST
/api/jobs/upload-input
Upload an input file for importing
POST
/api/keys/default
Get or Create a Default API Key
POST
/api/products/streams
Create a Product Stream
POST
/api/public/rebookings
POST
/api/support/ticket-lookup
Look up the last transaction by email and resend the order confirmation
POST
/api/tickets/free
Create free Tickets
POST
/api/users/access-seller
Change Seller on User
POST
/api/users/invite
Invite a User
POST
/api/users/login
Login a User
POST
/api/users/password-reset
Request a password reset mail
POST
/api/users/refresh
Refresh authentication token
POST
/api/accessusers/scans/{eventId}
Create scans
POST
/api/cancellations/{id}/invoice
Create invoice for cancellation
POST
/api/checkout/{id}/confirmation-sms
Send a confirmation SMS for a checkout
POST
/api/checkout/{id}/internal
Complete an Internal Checkout
POST
/api/checkout/{id}/confirmation-mail
Resend confirmation mail
POST
/api/checkout/{id}/items
Update checkout items
POST
/api/checkout/{id}/confirm-payment-plan
Confirm a payment plan
POST
/api/checkout/{id}/confirm-subscription
Confirm a subscription
POST
/api/checkout/{id}/reserve
Reserve a checkout
POST
/api/checkout/{id}/confirm-cpm
Confirm a checkout via CPM
POST
/api/checkout/{id}/abort
Abort a checkout
POST
/api/checkout/{id}/details
Post checkout details
POST
/api/checkout/{id}/reserved-invitation-mail
Resend invitation mail
POST
/api/coupon/{id}/decouple
Decouple coupon from coupon series
POST
/api/customers/verify/resend
Resend verification mail
POST
/api/customers/verify/{token}
Verify a Customer
POST
/api/customers/{id}/erase-data
Erase Customer data
POST
/api/customers/{id}/account
Create account for Customer
POST
/api/disputes/{id}/stop-automation
Stop dispute automation
POST
/api/events/{id}/recurrences
Add Recurrences
POST
/api/events/{id}/seatmap-share-link
Generate a read-only seatmap share link
POST
/api/events/{id}/seating
Set the seating event id of an event
POST
/api/events/{id}/decouple
Decouple event
POST
/api/payments/requests/setup
Create a Payment Request for Customer Payment Method Setup
POST
/api/pos/{id}/disable
Disable POS
POST
/api/pos/{id}/convert-checkout
Convert Checkout
POST
/api/pos/{id}/close
Close a POS session
POST
/api/pos/{id}/open
Open a POS session
POST
/api/printjob/{id}/status
Update a Print job's status
POST
/api/public/purchaseintents/checkout
Create a checkout for multiple PurchaseIntents
POST
/api/public/resell/offers
Create an offer as a customer
POST
/api/public/tickets/claim
Claim tickets
POST
/api/public/tickets/repersonalization
Request repersonalization
POST
/api/public/tickets/upgrade
Upgrade tickets
POST
/api/purchaseintents/{id}/history
Add history entry
POST
/api/purchaseintents/{id}/reservation-mail
Send a reservation mail
POST
/api/purchaseintents/{id}/cancel
Cancel a purchase intent
POST
/api/purchaseintents/{id}/split
Split a PurchaseIntent
POST
/api/purchaseintents/{id}/approval
Set approval status
POST
/api/purchaseintents/{id}/create-tickets
Create purchase intent tickets
POST
/api/resell/offers/preview
Preview offer
POST
/api/sales-channels/{id}/archive
Archive a sales channel
POST
/api/subscriptions/{id}/checkout
Creates a checkout for a draft subscription (internal)
POST
/api/supports/{id}/assign-seller
Update seller assignment
POST
/api/supports/{id}/assignee
Change support ticket assignee
POST
/api/supports/{id}/message
Reply to support ticket
POST
/api/supports/{id}/status
Change support ticket status
POST
/api/supports/{id}/seller
Change support ticket seller
POST
/api/supports/{id}/prio
Change support ticket prio
POST
/api/third/exchange/listings
Notifies the system that a ticket has been listed on a third party platform
POST
/api/third/exchange/swap
Swap a ticket with barcode and new customer information
POST
/api/ticket-transfers/{id}/reject
Reject Ticket Transfer
POST
/api/ticket-transfers/{id}/accept
Accept Ticket Transfer
POST
/api/tickets/{id}/reissue
Reissue Ticket
POST
/api/tickets/{id}/invalidate
Invalidate Ticket
POST
/api/tickets/{id}/mail
Send Ticket per mail
POST
/api/tickets/{id}/seat
Change Ticket's seat
POST
/api/tickets/{id}/validate
Validate Ticket
POST
/api/tickets/{id}/detailsrequired
Require Details
POST
/api/tickets/{id}/preparedelivery
Prepare Ticket for delivery
POST
/api/transactions/{id}/order-sms
Send an order SMS for a transaction
POST
/api/transactions/{id}/ticket-mail
Send transaction tickets per mail
POST
/api/transactions/{id}/invitationmail
Send a Transaction reserved invitation mail
POST
/api/transactions/{id}/paymentstatus
Update the payment status
POST
/api/transactions/{id}/cancel
Cancel a Transaction
POST
/api/transactions/{id}/complete
Complete a Transaction
POST
/api/transactions/{id}/resendconfirmationmail
Resend a Transaction booking confirmation mail
POST
/api/transactions/{id}/voucher-mail
Send transaction vouchers per mail
POST
/api/transactions/{id}/history
Add history entry
POST
/api/users/notifications/deviceinfo
Get notification device info
POST
/api/users/notifications/subscribe
Subscribe notification type
POST
/api/users/notifications/unsubscribe
Unsubscribe notification type
POST
/api/users/{id}/roles
Add User roles
DELETE
/api/users/{id}/roles
Remove User roles
POST
/api/users/{id}/permissions
Add User permissions
DELETE
/api/users/{id}/permissions
Remove User permissions
POST
/api/accessusers/tickets/{barcode}/scan
Scan Ticket with barcode
POST
/api/distribution/checkout/{id}/extend
Extend the expiry time of a checkout by one hour.
POST
/api/distribution/checkout/{id}/complete
Complete a checkout.
POST
/api/distribution/checkout/{id}/abort
Abort a checkout.
POST
/api/distribution/transaction/{id}/cancel
Cancel a transaction.
POST
/api/payments/plans/{id}/complete
Complete a Payment Plan
POST
/api/payments/requests/{id}/processor
Receive Processor Info
POST
/api/payments/requests/{id}/confirm
Confirm a Payment Request
POST
/api/payments/requests/{id}/payment-status
Change Payment Request Payment Status
POST
/api/payments/requests/{id}/verify
Verify a payment request
POST
/api/pos/{id}/cancel/{transactionId}
Cancel POS Transaction
POST
/api/public/purchaseintents/{id}/checkout
Create PurchaseIntent's checkout
POST
/api/public/purchaseintents/{id}/cancel
Public Cancel a Purchase Intent
POST
/api/public/resell/offers/preview
Preview an offer as a customer
POST
/api/public/subscriptions/{id}/checkout
Creates a checkout for a draft subscription or a interactive recurring renewal
POST
/api/public/tickets/{id}/return
Return a Ticket
POST
/api/public/tickets/{id}/invalidate
Invalidate Ticket
POST
/api/resell/offers/{id}/cancel
Cancel an offer
POST
/api/sellers/{id}/fiscalization/initialize
Initialize Fiscalization of a Seller
POST
/api/subscriptions/cycles/{id}/active
Activate a Subscription Cycle
POST
/api/subscriptions/cycles/{id}/retry
Retry a Subscription Cycles failed actions
POST
/api/third/exchange/swap/tickets
Swap multiple tickets with new customer information
POST
/api/tickets/batch/{id}/invalidate
Invalidate Tickets of a Batch
POST
/api/tickets/batch/{id}/mail
Send batch tickets per mail
POST
/api/tickets/personalize/{id}/{secret}
Personalize a Ticket
POST
/api/customers/me/payment-methods/{id}/delete
Delete customer payment method of logged in customer
POST
/api/customers/me/payment-methods/{id}/primary
Set customer payment method of logged in customer to primary
POST
/api/customers/{customerId}/payment-methods/{paymentMethodId}/primary
Set customer payment method to primary
POST
/api/customers/{customerId}/payment-methods/{paymentMethodId}/delete
Delete customer payment method
POST
/api/pos/{id}/checkout/{checkoutId}/details
Post POS checkout details
POST
/api/public/packages/configs/{slug}/checkout
POST
/api/public/payments/plans/{id}/complete
Complete a Public Payment Plan
POST
/api/public/resell/offers/{id}/cancel
Public cancel an offer
POST
/api/sellers/{id}/product-plans/{planId}/deactivate
Deactivate a product plan for a seller
POST
/api/sellers/{id}/product-plans/{planId}/activate
Activate a product plan for a seller
POST
/api/subscriptions/{id}/transactions/{transactionId}/retry
Retry a transaction
POST
/api/third/exchange/listings/{id}/cancel
Notifies the system that a listings has been canceled on a third party platform
POST
/api/payments/plans/{paymentPlanId}/schedules/{scheduleId}/retry
Retry a Payment Plan Schedule
POST
/api/public/payments/plans/{paymentPlanId}/schedules/{scheduleId}/retry
Retry a Public Payment Plan Schedule
PATCH
/api/customers/transfers/bulk
Update Status of Transfers
PATCH
/api/purchaseintents/{id}/items
Amend a PurchaseIntent's Items
PUT
/api/purchaseintents/{id}/items
Update a PurchaseIntent's Items
PATCH
/api/sellers/{id}/consents
Update consent information
PATCH
/api/sellers/{id}/modules
Update modules
PUT
/api/accessusers/{id}
Update an Access User
DELETE
/api/accessusers/{id}
Delete an Access User
PUT
/api/image/{id}
Update an Image
DELETE
/api/image/{id}
Delete an Image
PUT
/api/users/{id}
Update User info
DELETE
/api/users/{id}
Delete a User
PUT
/api/webhook/{id}
Update a webhook
DELETE
/api/webhook/{id}
Delete a Webhook
PUT
/api/marketing/short-links/{id}
Update a Short Link
DELETE
/api/marketing/short-links/{id}
Delete a Short Link
PUT
/api/users/{id}/logintype
Update User Login Type
PUT
/api/subscriptions/{id}/items/{itemId}
Update Subscription Items
DELETE
/api/subscriptions/{id}/items/{itemId}
Update Subscription Items
PUT
/api/supports/{id}/messages/{messageId}
Update a support message
PUT
/api/users/{userId}/sellers/add
Add Seller to a User
PUT
/api/public/subscriptions/{id}/items/{itemId}
Update a Subscription Item
DELETE
/api/third/queue-slips
Delete queue slips
DELETE
/api/customers/me/passkeys/{credentialId}
Delete customer passkey
DELETE
/api/users/{userId}/sellers/remove
Remove a Seller of a User
Schemas 454
The contract defines 454 schemas that model the data the API accepts and returns. The most detailed are PATCH_Sellers_UpdateModules (95 properties), EventResource (79 properties), PUT_Events_UpdateAnEvent (73 properties), EventInfoResource (68 properties). Each schema is shown below with its type and property counts.
GET_Customers_ResetPassword_200_response
object
1 property
1 required
PUT_Sales-channels_UpdateASalesChannelGroup
object
4 properties
3 required
GET_Pos_GetScannableInformationForACode_200_response
POST_Users_SubscribeNotificationType
object
4 properties
4 required
POST_Checkout_AbortACheckout
object
1 property
1 required
POST_Subscription-cycles_CreateASubscriptionCycle_201_response
object
20 properties
10 required
POST_Fee-schemes_CreateAFeeScheme
object
2 properties
1 required
DistributionSeatingGroupResource
object
9 properties
4 required
GET_Transaction_GetTransactionsPublicInfo_200_response
object
30 properties
5 required
PUT_Products_UpdateAProduct
object
13 properties
2 required
POST_Queue-slips_CreateCheckoutQueueSlipPopulatorJob
object
12 properties
2 required
PUT_Payment-requests_UpdateAPaymentRequest
object
3 properties
3 required
GET_Jobs_GetAllJobs_200_response
object
2 properties
GET_Payment-strategies_GetPublicPaymentStrategy_200_response
object
5 properties
5 required
POST_Customers_CreateCustomer
object
18 properties
1 required
POST_Transactions_SendAnOrderSmsForATransaction
object
1 property
InvoiceResource
object
The invoice of the transaction
26 properties
7 required
PUT_Organizations_UpdateAnOrganization_200_response
object
8 properties
2 required
GET_Pos_GetPosSessions_200_response
array
POST_Auth_ExchangeAToken
object
1 property
1 required
PublicListingEventResource
object
37 properties
4 required
POST_Supports_ChangeSupportTicketSeller
object
1 property
1 required
PaymentResource
object
14 properties
8 required
POST_Api_keys_CreateAnApiKey
object
3 properties
1 required
GET_Invoices_GetAllInvoices_200_response
object
2 properties
GET_Checkout_GetATransaction_200_response
object
30 properties
5 required
GET_Tickets_GetTicketPrintData_200_response
object
12 properties
7 required
POST_Queue-slips_CreateTicketQueueSlipPopulatorJob
object
12 properties
2 required
CouponRichResource
AccessListResource
object
5 properties
4 required
POST_Resell-offers_CreateAnOffer_200_response
object
11 properties
10 required
PUT_Customers_SetANewPassword
object
2 properties
2 required
PUT_Tickets_UpdateATicket
object
3 properties
DELETE_Webhooks_DeleteAWebhook_200_response
object
7 properties
3 required
PATCH_Sellers_UpdateConsentInformation_200_response
object
64 properties
2 required
LegalIdentificationDocumentResource
GET_Products_GetAProductStreamsProducts_200_response
array
GET_Invoices_GetPublicInvoiceForTransaction_200_response
object
7 properties
1 required
POST_Ticket-transfers_AcceptTicketTransfer
object
4 properties
3 required
PublicVoucherInfoResource
object
3 properties
3 required
GET_Document-templates_GetThePublicDocumentTemplate_200_response
object
11 properties
6 required
GET_Credit-notes_ListCreditNotes_200_response
object
2 properties
PUT_Event-series_UpdateAnEventSeries_200_response
object
7 properties
3 required
POST_Checkout_CompleteAnInternalCheckout
object
12 properties
2 required
GET_Payment-plans_GetAPaymentPlansPublicInformationBasedOnTheTransaction_200_response
object
11 properties
9 required
POST_Ticket-transfers_CreateTicketTransfer
object
4 properties
2 required
GET_Event-series_GetAnEventSeries_200_response
object
7 properties
3 required
POST_Notifications_UpdateActionNotificationSubscription
object
1 property
POST_Customers_RequestAPasswordResetMail
object
2 properties
2 required
POST_Pos_OpenAPosSession
object
1 property
PUT_Users_UpdateUserInfo
object
1 property
1 required
GET_Coupons_GetCouponOrVoucherByCode_200_response
object
4 properties
1 required
CustomerPaymentMethodResource
object
12 properties
6 required
PUT_Vouchers_UpdateAVoucher
object
2 properties
1 required
GET_Sellers_GetSellerInfo_200_response
object
30 properties
2 required
POST_Webhooks_CreateANewWebhook_201_response
object
7 properties
3 required
POST_Invoices_CreateInvoiceForTransaction
object
1 property
1 required
EventResource
object
The associated event which has been deleted
79 properties
6 required
POST_Checkout_ConfirmACheckoutViaCpm
object
2 properties
2 required
POST_Bundles_CreateABundle
object
8 properties
6 required
POST_Bundles_CreateABundle_201_response
object
12 properties
8 required
GET_Distribution-api_GetAllEventsForASeller_200_response
object
2 properties
GET_Payment-strategies_GetPaymentStrategies_200_response
object
2 properties
POST_Checkout_CreateACheckout
object
11 properties
3 required
POST_Supports_UpdateSellerAssignment
object
1 property
1 required
PATCH_Supports_PatchASupportTicket
object
1 property
POST_Purchaseintents_AddHistoryEntry
object
2 properties
2 required
FundResource
object
7 properties
5 required
POST_Purchaseintents_CreatePurchaseIntentsCheckout
object
2 properties
GET_Invoices_GetPublicInvoiceForTransactionDeprecatedUseGetPublicInvoicesInfoWithQueryParametersTransactionIdAndSecretInstead_200_response
object
7 properties
1 required
GET_Events_GetAllEvents_200_response
object
2 properties
POST_Checkouts_CreateACheckout
object
13 properties
4 required
POST_Sales-channels_CreateASalesChannel
PUT_Events_UpdateAnEvent
object
73 properties
POST_Payment-plans_CompleteAPublicPaymentPlan
object
1 property
1 required
POSSessionResource
object
12 properties
4 required
POST_Sellers_CreateASeller
object
32 properties
11 required
POST_Resell-offers_CreateAnOffer
object
5 properties
5 required
GET_Events_GetPublicListingEvents_200_response
array
POST_Supports_ChangeSupportTicketAssignee
object
1 property
1 required
GET_Products_GetAllProductStreams_200_response
object
2 properties
POST_Tickets_SendTicketPerMail
object
1 property
1 required
VoucherResource
object
11 properties
4 required
POST_Checkout_PostCheckoutDetails
object
21 properties
5 required
PublicEventResource
object
45 properties
4 required
POST_Resell-offers_PublicCancelAnOffer_200_response
object
11 properties
10 required
POST_Document-templates_CreateADocumentTemplate_201_response
object
11 properties
6 required
GET_Data-fields_GetAllDataFields_200_response
array
PriceTableResource
object
6 properties
3 required
POST_Accessusers_CreateScans
array
POST_Price-tables_CreateAPriceTable
object
4 properties
1 required
GET_Events_GetEventsWithStatus_200_response
array
CouponResource
SubscriptionItemResource
object
23 properties
4 required
POST_Jobs_CreateAnJob
ScanGroupResource
object
7 properties
5 required
POST_Products_CreateAProductStream_201_response
object
7 properties
3 required
PUT_Subscription-plans_UpdateASubscriptionPlan
object
8 properties
GET_Third_ValidatesTheActiveListingForMultipleTickets_200_response
object
3 properties
1 required
CouponCreateResource
POST_Auth_ExchangeAToken_200_response
object
2 properties
2 required
PUT_Products_UpdateAProductStream
object
3 properties
1 required
GET_Access-lists_GetAnAccessListEntrysTicket_200_response
object
38 properties
9 required
PUT_Bundles_UpdateABundle
object
12 properties
GET_Checkout_GetAllTicketsForACheckout_200_response
object
1 property
GET_Bundles_GetAllBundles_200_response
object
2 properties
PUT_Jobs_UpdateAScheduledJob_200_response
object
9 properties
5 required
GET_Tickets_GetTicketsOfBatch_200_response
array
GET_Pos_GetPosEvents_200_response
object
2 properties
POST_Purchaseintents_SetApprovalStatus
object
2 properties
PaymentRequestProcessorResource
object
6 properties
2 required
POST_Users_UnsubscribeNotificationType
object
2 properties
2 required
GET_Resell-offers_GetOfferById_200_response
object
11 properties
10 required
POST_Purchaseintents_CreatePurchaseIntentStrategies
object
7 properties
4 required
PUT_Supports_UpdateASupportTicket
object
1 property
GET_Reports_GetReport_200_response
object
2 properties
POST_Subscription-cycles_RetryASubscriptionCyclesFailedActions_200_response
object
20 properties
10 required
PUT_Subscription-cycles_UpdateASubscriptionCycle
object
11 properties
GET_Customers_GetTransactionsOfCustomer_200_response
object
2 properties
POST_Resell-offers_CreateAnOfferAsACustomer
object
4 properties
4 required
GET_Webhooks_GetAllWebhooks_200_response
object
2 properties
DistributionAvailabilityResource
object
11 properties
9 required
GET_Events_GetEventParents_200_response
array
POST_Purchaseintents_SendAReservationMail
object
1 property
GET_Ticket-transfers_GetAllTicketTransfers_200_response
object
2 properties
PerkResource
object
7 properties
5 required
POST_Checkout_SendAConfirmationSmsForACheckout
object
1 property
GET_Transactions_GetAllTransactionsRich_200_response
object
2 properties
PUT_Bundles_UpdateABundle_200_response
object
12 properties
8 required
PUT_Purchaseintents_UpdateAPurchaseIntentsItems
object
2 properties
GET_Purchaseintents_GetAllPurchaseIntents_200_response
object
2 properties
POST_Jobs_CreateAnJob_202_response
PUT_Payment-plans_UpdateAPaymentPlan_200_response
object
16 properties
14 required
DistributionCheckoutResource
object
7 properties
3 required
GET_Distribution-api_GetTheAvailabilitiesForAnEvent_200_response
object
2 properties
POST_Customers_CreateAccountForCustomer
object
1 property
POST_Payment-requests_CreateAPaymentRequestForCustomerPaymentMethodSetup
object
4 properties
GET_Customers_GetTicketTransfersOfCustomer_200_response
object
2 properties
GET_Transactions_GetTransactionCancellationInfo_200_response
object
1 property
PATCH_Sellers_UpdateModules
object
95 properties
POST_Accessusers_CreateAnAccessUser
object
2 properties
1 required
DistributionEventResource
object
14 properties
10 required
PUT_Customers_SetANewPassword_200_response
object
1 property
1 required
CouponSeriesResource
object
28 properties
3 required
POST_Purchaseintents_PublicCancelAPurchaseIntent
object
1 property
1 required
POST_Third_NotifiesTheSystemThatATicketHasBeenListedOnAThirdPartyPlatform
object
2 properties
2 required
GET_Document-templates_GetDocumentTemplates_200_response
array
POST_Vouchers_CreateAVoucher
object
3 properties
1 required
GET_Jobs_GetAllScheduledJobs_200_response
object
2 properties
GET_Accessusers_GetTicketWithBarcode_200_response
object
13 properties
8 required
POST_Events_CreateAnEvent
object
60 properties
2 required
PUT_Access-lists_UpdateAnAccessList
object
2 properties
1 required
POST_Sales-channels_CreateASalesChannelGroup
object
4 properties
3 required
POST_Checkout_ConfirmAPaymentPlan
object
4 properties
4 required
POST_Tickets_CreateFreeTickets_201_response
array
GET_Pos_GetAllPosInfos_200_response
object
2 properties
POST_Tickets_UpgradeTickets
object
3 properties
1 required
PublicResellOfferInfoResource
object
8 properties
7 required
GET_Api_GetAllTicketsForASubscription_200_response
array
DataFieldResource
object
12 properties
5 required
POSWithStatusResource
object
13 properties
5 required
POST_Jobs_CreateAScheduledJob_201_response
object
9 properties
5 required
POST_Jobs_UploadAnInputFileForImporting_200_response
object
1 property
1 required
GET_Jobs_GetAnJob_200_response
POST_Purchaseintents_CreateACheckoutForMultiplePurchaseIntents
object
1 property
GET_Transactions_GetTransactionOfATicket_200_response
object
30 properties
5 required
POST_Tickets_SendBatchTicketsPerMail
object
1 property
1 required
POSResource
object
11 properties
5 required
GET_Ticket-transfers_GetPublicTicketTransfers_200_response
array
CouponWithSeriesResource
object
9 properties
2 required
CampaignResource
object
8 properties
8 required
PaymentGatewayResource
object
16 properties
6 required
GET_Accessusers_GetTicketsForAnEvent_200_response
object
2 properties
POST_Transactions_CreateATransactionCancellation_200_response
object
8 properties
4 required
POST_Payment-requests_VerifyAPaymentRequest
object
2 properties
1 required
POST_Images_CreateAnImage_201_response
object
8 properties
4 required
PUT_Checkout_UpdateACheckout
object
2 properties
1 required
GET_Credit-notes_GetCreditNoteInfo_200_response
object
5 properties
1 required
POST_Checkout_ResendInvitationMail
object
1 property
GET_Cancellations_GetAllCancellations_200_response
object
2 properties
GET_Refunds_GetAllRefunds_200_response
object
2 properties
DELETE_Products_DeleteAProductStream_200_response
object
7 properties
3 required
GET_Payment-plans_GetAPaymentPlan_200_response
object
16 properties
14 required
PUT_Event-series_UpdateAnEventSeries
object
3 properties
PUT_Users_AddSellerToAUser
object
2 properties
1 required
GET_Transactions_GetTransactionsPublicTickets_200_response
object
30 properties
5 required
ShortLinkResource
object
13 properties
6 required
CouponSeriesUpdateResource
object
24 properties
PUT_Document-templates_UpdateADocumentTemplate
object
5 properties
POST_Third_NotifiesTheSystemThatATicketHasBeenListedOnAThirdPartyPlatform_200_response
object
3 properties
1 required
AccessUserInfoResource
object
5 properties
4 required
GET_Organizations_GetAnOrganizationsPublicInfo_200_response
object
5 properties
2 required
POST_Third_SwapATicketWithBarcodeAndNewCustomerInformation
object
2 properties
1 required
POST_Customers_VerifyACustomer_200_response
object
1 property
1 required
PUT_Sellers_UpdateASeller
object
52 properties
9 required
AccessListEntryResource
object
10 properties
4 required
PublicPurchaseIntentResource
object
43 properties
14 required
PublicTicketTransferResource
object
10 properties
5 required
PUT_Invoices_UpdateAnInvoice
object
3 properties
1 required
POST_Payment-requests_ReceiveProcessorInfo
object
2 properties
1 required
GET_Products_GetAPublicProduct_200_response
object
17 properties
4 required
GET_Resell-offers_GetListingOfOffer_200_response
object
9 properties
8 required
GET_Document-templates_GetAllDocumentTemplates_200_response
object
2 properties
DistributionSellerResource
object
4 properties
3 required
POST_Auth_CreateAnExchangeToken_200_response
object
2 properties
2 required
POST_Resell-offers_PreviewOffer_200_response
object
3 properties
3 required
PUT_Fee-schemes_UpdateAFeeScheme
object
2 properties
SalesChannelResource
object
10 properties
5 required
GET_Api_GetAllSubscriptions_200_response
object
2 properties
GET_Transactions_GetAllTransactionTickets_200_response
array
GET_Customers_GetAllCustomers_200_response
object
2 properties
PaymentRequestResource
object
18 properties
6 required
CustomerResource
object
The associated customer which has been updated
23 properties
2 required
POST_Checkout_UpdateCheckoutItems
object
7 properties
3 required
PUT_Images_UpdateAnImage_200_response
object
8 properties
4 required
PATCH_Sellers_UpdateModules_200_response
object
64 properties
2 required
GET_Methods_GetSellersPaymentMethods_200_response
array
POSJournalLogResource
object
8 properties
4 required
PUT_Products_UpdateAProductStream_200_response
object
7 properties
3 required
POST_Payment-plans_RetryAPaymentPlanSchedule_200_response
object
16 properties
14 required
PUT_Purchaseintents_UpdateAPurchaseIntentStrategy
object
7 properties
POST_Organizations_CreateAnOrganization
object
3 properties
2 required
PUT_Webhooks_UpdateAWebhook
object
5 properties
2 required
GET_Api_200_response
object
16 properties
9 required
ChargebackResource
object
11 properties
3 required
POST_Transactions_CancelPosTransaction
object
2 properties
POST_Auth_CreateAnExchangeToken
GET_Payment-requests_GetPaymentRequests_200_response
object
2 properties
GET_Transactions_GetAllTransactions_200_response
object
2 properties
POST_Rebooking
object
4 properties
1 required
PUT_Api_keys_UpdateAnApiKey
object
3 properties
POSInfoResource
object
7 properties
7 required
GET_Pos_GetTheIDsAndTheTypesOfAllActivePosPaymentGateways_200_response
object
1 property
GET_Notifications_GetNotificationSettingsForTheAuthenticatedUser_200_response
object
1 property
1 required
GET_Customer-payment-methods_GetCustomerPaymentMethods_200_response
array
POST_Images_CreateAnImage
object
4 properties
2 required
POST_Api_PostPosCheckoutDetails
object
15 properties
1 required
GET_Subscription-cycles_GetAllSubscriptionCycles_200_response
object
2 properties
DELETE_Products_DeleteAProduct_200_response
object
17 properties
4 required
GET_Subscription-cycles_GetASubscriptionCycle_200_response
object
20 properties
10 required
POST_Channels_CreateAChannel
object
3 properties
2 required
GET_Vouchers_GetAllVouchers_200_response
object
2 properties
POST_Supports_ChangeSupportTicketPrio
object
1 property
1 required
POST_Distribution-api_ExtendTheExpiryTimeOfACheckoutByOneHour
object
1 property
1 required
EntitlementConditionTree
object
3 properties
POST_Supports_ReplyToSupportTicket
object
1 property
1 required
POST_Transactions_SendTransactionVouchersPerMail
object
1 property
GET_Event-series_GetAllEventSeries_200_response
object
2 properties
POST_Payment-strategies_CreateAPaymentStrategy
object
3 properties
3 required
POST_Data-fields_CreateADataField
object
9 properties
2 required
DELETE_Event-series_DeleteAnEventSeries_200_response
object
7 properties
3 required
POST_Webhooks_CreateANewWebhook
object
5 properties
2 required
PUT_Customers_UpdateCustomer
object
17 properties
TicketTransferResource
object
The associated ticket transfer which has been expired
15 properties
9 required
CheckoutPOSDataResource
object
2 properties
GET_Customers_GetResellOffersOfCustomer_200_response
object
2 properties
GET_Invoices_GetPublicInvoice_200_response
object
7 properties
1 required
GET_Payments_GetPayments_200_response
object
2 properties
GET_Fee-schemes_GetAllFeeSchemes_200_response
object
2 properties
GET_Checkout_GetDetailsForm_200_response
object
6 properties
GET_Accessusers_GetAllAccessUsers_200_response
array
POST_Transactions_UpdateThePaymentStatus
object
1 property
1 required
PUT_Data-fields_UpdateADataField
object
7 properties
GET_Pos_GetAllPos_200_response
array
POST_Distribution-api_CancelATransaction
object
1 property
1 required
GET_Pos_GetPosJournalLogs_200_response
object
2 properties
TransactionResource
object
63 properties
6 required
RedactedAPIKeyResource
object
9 properties
4 required
GET_Purchaseintents_GetAllPurchaseIntentStrategies_200_response
array
PUT_Pos_UpdatePos
object
5 properties
4 required
GET_Sales-channels_GetAllSalesChannels_200_response
object
2 properties
POST_Event-series_CreateAnEventSeries
object
3 properties
1 required
POST_Api
object
5 properties
3 required
POST_Document-templates_CreateADocumentTemplate
POST_Resell-offers_PreviewAnOfferAsACustomer_200_response
object
3 properties
3 required
GET_Payment-gateways_GetAllPaymentGateways_200_response
array
PledgeResource
object
15 properties
8 required
POST_Access-lists_CreateAnAccessListEntry
object
7 properties
1 required
POST_Supports_CreateASupportTicket
object
7 properties
3 required
GET_Products_GetAProductStream_200_response
object
7 properties
3 required
GET_Customers_GetUndershopsOfCustomer_200_response
object
1 property
POST_Payment-plans_CompleteAPublicPaymentPlan_200_response
object
11 properties
9 required
GET_Distribution-api_GetAllSellers_200_response
object
2 properties
POST_Distribution-api_AbortACheckout
object
1 property
1 required
PATCH_Sellers_UpdateConsentInformation
object
1 property
POST_Checkout_ResendConfirmationMail
object
1 property
PUT_Printjob_UpdateAPrintJob
object
7 properties
2 required
PUT_Payment-strategies_UpdateAPaymentStrategy_200_response
object
5 properties
5 required
GET_Access-lists_GetAllAccessListEntries_200_response
object
2 properties
POST_Payment-gateways_CreateAPaymentGateway
object
5 properties
1 required
PUT_Products_UpdateAProduct_200_response
object
17 properties
4 required
PUT_Api
object
11 properties
DELETE_Document-templates_DeleteADocumentTemplate_200_response
object
11 properties
6 required
GET_Bundles_GetABundle_200_response
object
12 properties
8 required
PUT_Payment-plans_UpdateAPublicPaymentPlan
object
2 properties
2 required
PUT_Document-templates_UpdateADocumentTemplate_200_response
object
11 properties
6 required
GET_Payment-plans_GetAPublicPaymentPlan_200_response
object
11 properties
9 required
GET_Customer-payment-methods_GetPaymentMethodsForCustomer_200_response
array
POST_Customers_LoginCustomer
object
4 properties
3 required
POST_Customers_LoginCustomer_200_response
object
1 property
1 required
PUT_Payment-plans_UpdateAPaymentPlan
object
2 properties
POST_Sellers_InitializeFiscalizationOfASeller
GET_Products_GetAllProducts_200_response
object
2 properties
PATCH_Purchaseintents_UpdateAPurchaseIntent
object
1 property
GET_Resell-offers_GetInternalTicketResellStatus_200_response
array
POST_Third_SwapMultipleTicketsWithNewCustomerInformation_200_response
array
POST_Api_201_response
object
16 properties
10 required
POST_Products_CreateAProduct_201_response
object
17 properties
4 required
SubscriptionResource
object
27 properties
7 required
GET_Images_GetAllImages_200_response
object
2 properties
GET_Payment-strategies_GetAPaymentStrategy_200_response
object
5 properties
5 required
POST_Transactions_AddHistoryEntry
object
2 properties
2 required
POST_Subscription-cycles_ActivateASubscriptionCycle_200_response
object
20 properties
10 required
POST_Third_SwapATicketWithBarcodeAndNewCustomerInformation_200_response
object
7 properties
5 required
PUT_Api_200_response
object
16 properties
10 required
POST_Payment-strategies_CreateAPaymentStrategy_200_response
object
5 properties
5 required
PUT_Channels_UpdateAChannel
object
3 properties
2 required
GET_Customers_GetAllCustomerTags_200_response
array
An array of tags
GET_Distribution-api_GetSeatingGroupsForAnEvent_200_response
object
2 properties
POST_Users_ChangeSellerOnUser
object
1 property
1 required
GET_Api_GetAllSubscriptionPlans_200_response
object
2 properties
POST_Access-lists_CreateAnAccessList
object
3 properties
1 required
CouponSeriesGenerateCouponsResponseResource
object
3 properties
3 required
POST_Third_NotifiesTheSystemThatAListingsHasBeenCanceledOnAThirdPartyPlatform_200_response
object
POST_Products_CreateAProductStream
object
3 properties
1 required
DELETE_Jobs_DeleteAScheduledJob_200_response
object
9 properties
5 required
POST_Tickets_ChangeTicketsSeat
object
4 properties
1 required
POST_Api_ConvertCheckout
object
4 properties
3 required
PUT_Payment-gateways_UpdateAPaymentGateway
object
9 properties
1 required
POST_Tickets_ClaimTickets
object
1 property
POST_Customers_UpdateCurrentCustomer
object
4 properties
POST_Users_RefreshAuthenticationToken
object
1 property
GET_Vouchers_GetVoucherByIdAndCode_200_response
object
5 properties
GET_Third_ValidateATicketByItsBarcode_200_response
object
7 properties
5 required
GET_Access-lists_GetAccessLists_200_response
object
2 properties
TicketResource
object
The associated ticket which has been updated
60 properties
10 required
CouponSeriesCreateResource
object
24 properties
1 required
EventInfoResource
object
68 properties
4 required
DaySchemeResource
object
4 properties
3 required
POST_Payment-requests_ChangePaymentRequestPaymentStatus
object
2 properties
2 required
EntitlementResource
object
9 properties
7 required
POST_Payment-plans_RetryAPublicPaymentPlanSchedule_200_response
object
11 properties
9 required
CreateFreeTicketValidationSchema
GET_Checkouts_GetAllCheckouts_200_response
object
2 properties
PUT_Jobs_UpdateAScheduledJob
object
5 properties
1 required
DistributionTransactionResource
object
4 properties
3 required
GET_Events_GetOffersForAnEvent_200_response
object
3 properties
GET_Events_GetAllEventsRich_200_response
object
2 properties
GET_Document-templates_GetADocumentTemplate_200_response
object
11 properties
6 required
GET_Distributor_GetDistributorForSalesChannel_200_response
object
2 properties
POST_Ticket-transfers_RejectTicketTransfer
object
1 property
1 required
DonationResource
object
15 properties
8 required
LanguageResource
string
The preferred language of the package checkout
RefundResource
object
10 properties
3 required
GET_Customers_GetPurchaseIntentsOfCustomer_200_response
array
POST_Queue-slips_CreateVoucherQueueSlipPopulatorJob
object
12 properties
2 required
PUT_Rebooking
object
5 properties
2 required
POSCloseSessionResource
object
15 properties
4 required
PurchaseIntentStrategyResource
object
10 properties
5 required
GET_Third_ReceiveTheTicketExchangePayloadForMultipleTickets_200_response
object
3 properties
1 required
POST_Purchaseintents_CreateAPurchaseIntent
object
14 properties
2 required
GET_Data-fields_GetAllDataFieldsByReference_200_response
array
CouponSingleResource
object
32 properties
1 required
PUT_Accessusers_UpdateAnAccessUser
object
8 properties
2 required
GET_Coupons_GetAllCouponSeries_200_response
array
POST_Resell-offers_CreateAnOfferAsACustomer_200_response
object
11 properties
10 required
POST_Accessusers_CreateScans_200_response
object
1 property
PUT_Api_UpdateASubscriptionItem
object
3 properties
1 required
CheckoutResource
object
The associated checkout
29 properties
7 required
AccessUserResource
object
15 properties
6 required
PUT_Supports_SendAMessage
object
1 property
1 required
PUT_Payment-plans_UpdateAPublicPaymentPlan_200_response
object
11 properties
9 required
PATCH_Notifications_UpdateNotificationSettingsForTheAuthenticatedUser_200_response
object
1 property
1 required
POST_Tickets_PersonalizeATicket
object
4 properties
GET_Accessusers_GetAssociatedSellerId_200_response
object
1 property
1 required
GET_Tickets_GetAllTickets_200_response
object
2 properties
PaymentMethodDetailsResource
object
3 properties
1 required
GET_Accessusers_GetTicketsForAnEventV2_200_response
object
2 properties
POST_Tickets_ReturnATicket
object
2 properties
2 required
GET_Events_GetPublicListingEvent_200_response
array
PATCH_Notifications_UpdateNotificationSettingsForTheAuthenticatedUser
object
1 property
1 required
PUT_Access-lists_UpdateAnAccessListEntry
object
7 properties
1 required
POST_Events_SetTheSeatingEventIdOfAnEvent
object
2 properties
2 required
POST_Purchaseintents_SplitAPurchaseIntent
object
3 properties
2 required
POST_Events_AddRecurrences
PUT_Images_UpdateAnImage
object
3 properties
1 required
ScanZoneResource
object
3 properties
3 required
POST_Users_GetNotificationDeviceInfo
object
1 property
1 required
POST_Payment-plans_CompleteAPaymentPlan_200_response
object
11 properties
9 required
CouponSeriesGenerateCouponsPayloadResource
object
4 properties
3 required
VoucherWithBalanceResource
object
12 properties
5 required
GET_Resell-offers_GetPublicTicketResellStatus_200_response
array
POST_Tickets_InvalidateTicketsOfABatch_201_response
array
SalesChannelGroupResource
object
8 properties
5 required
PUT_Api_UpdateASubscription
object
5 properties
1 required
POST_Events_DuplicateAnEvent
PublicSubscriptionResource
object
26 properties
7 required
GET_Organizations_GetAllOrganizations_200_response
object
2 properties
POST_Printjob_UpdateAPrintJobsStatus
object
1 property
POST_Supports_ChangeSupportTicketStatus
object
1 property
1 required
POST_Resell-offers_CancelAnOffer_200_response
object
11 properties
10 required
POST_Organizations_CreateAnOrganization_201_response
object
8 properties
2 required
POST_Payment-requests_CreateAPaymentRequest
object
3 properties
1 required
POST_Event-series_CreateAnEventSeries_201_response
object
7 properties
3 required
POSListingEventResource
object
41 properties
5 required
DELETE_Users_RemoveASellerOfAUser
object
1 property
1 required
POST_Transactions_SendTransactionTicketsPerMail
object
1 property
PUT_Price-tables_UpdateAPriceTable
object
4 properties
DELETE_Queue-slips_DeleteQueueSlips
object
3 properties
3 required
PublicSupportResource
object
18 properties
8 required
PUT_Webhooks_UpdateAWebhook_201_response
object
7 properties
3 required
GET_Purchaseintents_GetPublicPurchaseIntentTickets_200_response
array
POST_Distribution-api_CreateACheckout
object
3 properties
2 required
POST_Users_RequestAPasswordResetMail
object
1 property
GET_Chargebacks_GetAllChargebacks_200_response
object
2 properties
PUT_Sales-channels_UpdateASalesChannel
GET_Jobs_GetAScheduledJob_200_response
object
9 properties
5 required
DELETE_Images_DeleteAnImage_200_response
object
8 properties
4 required
POST_Payment-requests_ConfirmAPaymentRequest
object
5 properties
1 required
POST_Checkout_ReserveACheckout
object
1 property
1 required
POST_Pos_CreateAPos
object
3 properties
2 required
GET_Products_GetAProduct_200_response
object
17 properties
4 required
PUT_Organizations_UpdateAnOrganization
object
8 properties
POST_Transactions_RequestRepersonalization
object
2 properties
1 required
PATCH_Purchaseintents_AmendAPurchaseIntentsItems
object
1 property
PUT_Api_UpdateSubscriptionItems
object
3 properties
1 required
POST_Checkout_ConfirmASubscription
object
2 properties
2 required
POST_Third_SwapMultipleTicketsWithNewCustomerInformation
object
4 properties
3 required
POSOpenSessionResource
object
1 property
GET_Customers_GetTicketsOfCustomer_200_response
object
2 properties
SubscriptionPlanResource
object
10 properties
3 required
PUT_Subscription-cycles_UpdateASubscriptionCycle_200_response
object
20 properties
10 required
GET_Api_keys_GetAllApiKeys_200_response
array
GET_Coupons_GetAllCoupons_200_response
object
2 properties
GET_Resell-offers_ListOffers_200_response
object
2 properties
GET_Price-tables_GetAllPriceTables_200_response
object
2 properties
POST_Subscription-cycles_CreateASubscriptionCycle
object
11 properties
1 required
POST_Products_CreateAProduct
object
13 properties
2 required
GET_Accessusers_GetAllAccessibleEvents_200_response
array
An array of all events the access user has access to.
POST_Transactions_CancelATransaction
object
2 properties
PurchaseIntentResource
object
The associated purchase intent which has been cancelled
44 properties
14 required
FeeSchemeResource
object
4 properties
2 required
POST_Distribution-api_CompleteACheckout
object
2 properties
2 required
GET_Payment-plans_ListPaymentPlans_200_response
object
2 properties
POST_Subscription-plans_CreateASubscriptionPlan
object
8 properties
1 required
POST_Accessusers_ScanTicketWithBarcode_200_response
object
2 properties
GET_Resell-offers_GetPublicResellListings_200_response
object
2 properties
POST_Api_keys_GetOrCreateADefaultApiKey
object
1 property
1 required
APIKeyResource
object
10 properties
5 required
GET_Organizations_GetAnOrganization_200_response
object
8 properties
2 required
PUT_Payment-strategies_UpdateAPaymentStrategy
object
3 properties
3 required
DistributorResource
object
4 properties
4 required
FiscalizationDataResource
Fiscalization data
POST_Jobs_CreateAScheduledJob
object
4 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from vivenu 12
Other APIs vivenu publishes across the network.
vivenu access-lists API
vivenu accessusers API
vivenu api_keys API
vivenu attributes API
vivenu auth API
vivenu billing API
vivenu bundles API
vivenu cancellations API
vivenu channels API
vivenu chargebacks API
vivenu checkout API
vivenu checkouts API
Where this information came from
This is an independent, third-party profile of vivenu api API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.