Skip to content

Premiere V2 API

Main Navigation API

Appearance

Sidebar Navigation

AccessPackages

GET Get access packages

POST Create a new access package

GET Get access package by ID

DELETE Delete an access package

PATCH Update an access package

Administrators

GET List administrators

POST Create administrator

GET Get administrator by ID

DELETE Delete administrator

PATCH Update administrator

POST Delete multiple administrators

GET GET /api/v2/administrator/login-report

GET Get the permission for the current admin user.

POST Login a user into the v2 api.

PUT Updates the current administrator's password.

AdministratorGroups

GET List administrator groups

POST Create administrator group

GET Get administrator group by ID

DELETE Delete administrator group

PATCH Update administrator group

Affiliates

GET List affiliates

POST Create affiliate

GET Get affiliate by ID

DELETE Delete affiliate

PATCH Update affiliate

POST Delete multiple affiliates

AnalyticsSettings

GET Get analytics settings

PATCH Update analytics settings

Settings / Appearance

GET Get all appearance settings

PATCH Update all appearance settings

Attendee Questions

GET List Attendee Questions

POST Create attendee question

GET Get Attendee Question by ID API Endpoint

DELETE Delete attendee question

PATCH Update ordering of attendee question

POST Create multiple attendee question

POST Delete multiple attendee questions

SettingsBadgePrinting

GET Get badge printing settings

PATCH Update badge printing settings

Settings

GET Get Box Office settings

PATCH Update Box Office settings

GET Get Receipt settings

PATCH Update Receipt settings

GET Get E Tickets settings

PATCH Update Tickets settings

GET Find Settings by Name

DELETE Delete one Settings by Setting Name

PATCH Update a setting

GET Find a list of Settings by a set of filters

POST Create Settings

POST Set the value of a global setting

BulkPricingRules

GET Get bulk pricing rules

POST Create a new bulk pricing rule

GET Get bulk pricing rule by ID

DELETE Delete a bulk pricing rule

PATCH Update a bulk pricing rule

Categories

GET Get categories

POST Create a new category

GET Get category by ID

DELETE Delete a category

PATCH Update a category

CategoryGroups

GET Get category groups

POST Create a new category group

GET Get category group by ID

DELETE Delete a category group

PATCH Update a category group

CheckinReport

GET Scan overview by event and ticket type

GET Scan details by administrator and scan type

Settings / Checkout

GET Get all checkout settings

PATCH Update all checkout settings

ConnectJobs

GET List connect jobs

POST Create connect job

GET Get connect job by id

DELETE Delete connect job (soft delete)

PATCH Update connect job

GET List recipients for a connect job

POST Start connect job run (legacy runner, asynchronous)

GET Find ConnectJob by Id

DELETE Delete one ConnectJob by Id

PATCH Update ConnectJob by Id

GET Find a list of ConnectJobs by a set of filters

POST Create ConnectJob

GET Find ConnectJob Members by Id

Customers

GET List customers

POST Create customer

GET Get customer

DELETE Delete customer

PATCH Update customer

POST Bulk delete customers

GET Export customers as CSV

DefaultLocalizationSettings

GET Get default localization

PATCH Update default localization

EmailTemplates

GET List email templates

POST Create email template

GET Get email template by ID

DELETE Delete email template permanently

PATCH Update email template

POST Duplicate email template

Events

GET Get Events API Endpoint

POST Create a new event

GET GetEvent by ID API Endpoint

DELETE Delete Event by ID

PATCH Update event

GET List ticket type tags

POST Duplicate event

GET Find Event by ID

GET Find events that match the provided input parameters

POST Create a new event

GET Find TicketTypes by Event ID

GET Find wave times for the given event.

POST Scans a ticket for an event.

POST Scans a ticket for a set of events.

Event Images

GET List event gallery images

POST Upload event gallery image

DELETE Delete event gallery image

POST Bulk delete event gallery images

POST Reorder event gallery images

EventShippingMethods

GET Get event shipping methods

PATCH Update event shipping method settings

PATCH Bulk update event shipping method settings

ExportJob

GET List all async CSV export jobs

GET Download a completed async export as CSV

DELETE Delete an async export job and its S3 file

FglCommands

GET List FGL template commands

POST Create FGL template command

GET Get FGL template command by ID

DELETE Delete FGL template command

PATCH Update FGL template command

POST Bulk delete FGL template commands

FglTemplates

GET List FGL templates

POST Create FGL template

GET Get FGL template by ID

DELETE Delete FGL template

PATCH Update FGL template

POST Bulk delete FGL templates

GeneralSettings

GET Get General settings

PATCH Update General settings

Settings / Incomplete Order Email

GET Get incomplete order email settings

PATCH Update incomplete order email settings

IntegrationsAuth0Settings

GET Get Auth0 integration settings

PATCH Update Auth0 integration settings

IntegrationsAvalaraSettings

GET Get Avalara integration settings

PATCH Update Avalara integration settings

IntegrationsGoFundraiseSettings

GET Get GoFundraise integration settings

PATCH Update GoFundraise integration settings

IntegrationsRaceResultSettings

GET Get RaceResult integration settings

PATCH Update RaceResult integration settings

IntegrationSalesforceSettings

GET Get Salesforce integration settings

PATCH Update Salesforce integration settings

IntegrationsActiveCampaign

GET Get Active Campaign settings

PATCH Update Active Campaign settings

GET Search ActiveCampaign lists

IntegrationsAudienceRepublic

GET Get Audience Republic settings

PATCH Update Audience Republic settings

IntegrationsDokeop

GET Get Dokeop settings

PATCH Update Dokeop settings

IntegrationsGoogle

GET Get Google Analytics and GTM settings

PATCH Update Google Analytics and GTM settings

IntegrationsHubspot

GET Get Hubspot settings

PATCH Update Hubspot settings

IntegrationsICS

GET Get Ice Cream Social settings

PATCH Update Ice Cream Social settings

IntegrationsIConnect

GET Get i-Connect settings

PATCH Update i-Connect settings

POST Pull orders from i-Connect

IntegrationsJustGiving

GET Get JustGiving integration settings

PATCH Update JustGiving integration settings

GET Get countries from JustGiving

IntegrationsKeap

GET Get Keap settings

PATCH Update Keap settings

IntegrationsKlaviyo

GET Get Klaviyo settings

PATCH Update Klaviyo settings

IntegrationsMailChimp

GET Get MailChimp settings

PATCH Update MailChimp settings

POST Get MailChimp email lists

IntegrationsMeta

GET Get Meta (Facebook) settings

PATCH Update Meta (Facebook) settings

IntegrationsMetaConversions

GET Get Meta Conversions settings

PATCH Update Meta Conversions settings

IntegrationsPurchaseProtection

GET Get Purchase Protection settings

PATCH Update Purchase Protection settings

IntegrationsS1P

GET Get Solution One Partners (S1P) settings

PATCH Update Solution One Partners (S1P) settings

IntegrationsSched

GET Get Sched settings

PATCH Update Sched settings

IntegrationsShipStation

GET Get ShipStation integration settings

PATCH Update ShipStation integration settings

IntegrationsStay22

GET Get Stay-22 settings

PATCH Update Stay-22 settings

IntegrationsTwilio

GET Get Twilio settings

PATCH Update Twilio settings

IntegrationsUsat

GET Get USAT integration settings

PATCH Update USAT integration settings

IntegrationsWalletSocket

GET Get WalletSocket settings

PATCH Update WalletSocket settings

IntegrationsZapier

GET Get Zapier settings

PATCH Update Zapier settings

IntegrationsZoho

GET Get Zoho settings

PATCH Update Zoho settings

LinkedSites

GET List linked sites

POST Create linked site

GET Get linked site by ID

DELETE Delete linked site

PATCH Update linked site

POST Delete multiple linked sites

Localizations

GET Get localizations

POST Create localization

GET Get localization by ID

DELETE Delete localization

PATCH Update localization

POST Duplicate localization

POST Delete multiple localizations

Orders

GET GET /orders

GET Get order

PATCH Update order

POST Refund order

POST Resend order email receipt

GET Export orders as CSV

GET Export tickets as CSV

GET Export purchasers as CSV

GET Export attendees as CSV

GET Export shipping details as CSV

GET Returns a single order

GET Retrieves a list of orders.

POST Creates an order once payment has been verified.

POST Scan all tickets in an order.

POST Process the cart data to describe what order would be created with it

POST Complete a staged order and run the after order processes

OrdersReport

GET Get per-day change order revenue aggregation for charting

GET Get change orders datatable (per event/ticket-type/change-type breakdown)

OrdersSettings

GET Get orders settings

PATCH Update orders settings

Organizers

GET List organizers

POST Create organizer

GET Get organizer by ID

DELETE Delete organizer

PATCH Update organizer

POST Delete multiple organizers

OrganizerSettings

GET Get organizer settings

PATCH Update organizer settings

OutgoingEmailSettings

GET Get outgoing email settings

PATCH Update outgoing email settings

ParticipantSettings

GET Get participant settings

PATCH Update participant settings

SettingsPaymentProcessors

GET Get OAuth authorization URL for Stripe or Square Connect

PUT Manually set connect access code (TicketSocket users only)

DELETE Disconnect Stripe or Square Connect

GET Get payment processors settings

PATCH Update payment processors settings

GET Get available Stripe locations

GET Get available Square locations

GET Get available Stripe terminals

PersonalSettings

GET Get personal settings

PATCH Update personal settings

Promo Codes

GET Get a list of promo codes

POST Create promo code

GET Get promo code by ID

DELETE Delete promo code

PATCH Update promo code

POST Bulk delete promo codes

POST Upload promo code import file (step 1)

POST Confirm promo code import (step 2)

GET Export filtered promo codes to CSV (zipped)

GET GET /api/v2/promo-code/

GET GET /api/v2/promo-code/{id}

POST Create a new Promo Code

GET GET /api/v2/promo-code/{id}/applies-to-ticket-type

GET GET /api/v2/promo-code/{id}/calculate-discount

PublicKeys

GET List public keys

POST Create public key

GET Get public key by ID

DELETE Delete public key

PATCH Update public key

POST Delete multiple public keys

PublicSettings

GET Get Public site settings

PurchaserQuestionReport

GET Get full question breakdown table with per-answer stats

GET Get purchaser question report summary (gross revenue, question count, answer count)

GET Get per-day question revenue for charting

GET Export purchaser question report as CSV (sync) or enqueue to S3 + DB (async)

QZPrintingSettings

GET Get QZ Printing settings

PATCH Update QZ Printing settings

Questions

GET Get questions

POST Create a new question

GET Get question by ID

DELETE Delete a question

PATCH Update a question

POST Delete multiple questions

GET Get question localizations

QuestionGroups

GET Get question groups

POST Create a new question group

GET Get question group by ID

DELETE Delete a question group

PATCH Update a question group

SalesReport

GET Get sales report summary (revenue, transactions, tickets sold)

GET Get per-day ticket value aggregation for charting

GET Get sales datatable (per-event breakdown with fees)

GET Get transaction datatable (per-transaction line items)

GET Get revenue datatable (per-event revenue metrics)

GET Get VAT datatable (per-transaction VAT breakdown)

GET Export a report type as a downloadable CSV

ShippingMethods

GET Get shipping methods

POST Create a new shipping method

GET Get shipping method by ID

DELETE Delete a shipping method

PATCH Update a shipping method

POST Delete multiple shipping methods

Stored Value Codes

GET Get a list of stored value codes

POST Create stored value code

GET Get stored value code by ID

DELETE Delete stored value code

PATCH Update stored value code

POST Bulk delete stored value codes

GET GET /api/v2/stored-value-code/

GET GET /api/v2/stored-value-code/{id}

POST Create a new StoredValueCode

TaxTypes

GET Get tax types

Teams

GET List teams

POST Create team

GET Get team by ID

DELETE Delete team

PATCH Update team

POST Bulk delete teams

POST Bulk remove tickets from a team

GET Find Team by Id

DELETE Delete one Team by Id

PATCH Update Team by Id

GET Find a list of Teams by a set of filters

POST Create Team

GET Find Team Members by Id

TeamSettings

GET Get team settings

PATCH Update team settings

Report Templates

GET Get report templates

POST Create a report template

GET List Basic Info field keys and default labels for report templates

GET Get report template by ID

DELETE Delete a report template

PATCH Update a report template

POST Duplicate a report template

POST Bulk delete report templates

GET Export data using selected report template(s)

Tickets

GET Get tickets

GET Check-in and sold stats for events

GET GET /tickets/{id}

DELETE DELETE /tickets/{id}

PATCH Update ticket

POST Check in ticket

POST Upload ticket profile photo

DELETE Delete ticket profile photo

POST Delete multiple tickets

GET GET /api/v2/ticket

GET Find Ticket by ID

GET Find Answers for Attendee questions on tickets

GET Pull the claim info for a given ticket either by ticketId or (id of the claim record - less likely)

GET Find out if a ticket has was sent as a claim or not

GET Find out if a ticket has been claimed or not

POST Modify the claimant email for a given ticket claim

POST POST /api/v2/ticket/{ticketId}/claim

GET Check if a bib number is available for a ticket

POST POST /api/v2/ticket/{ticketId}/states

TicketGroups

GET Get ticket groups

POST Create a new ticket group

GET Get ticket group by ID

DELETE Delete a ticket group

PATCH Update a ticket group

TicketImports

GET List ticket imports

POST Create ticket import

GET Get mapping fields

GET Get ticket import by ID

DELETE Delete ticket import

PATCH Update ticket import

GET Preview ticket import

POST Process ticket import

TicketRules

GET Get ticket rules

GET Get ticket rule by type and ID

DELETE Delete ticket rule

PATCH Update ticket rule

POST Create ticket rule

POST Bulk delete ticket rules

TicketTypeShippingMethods

POST Create a ticket type shipping method assignment

POST Bulk create ticket type shipping method assignments

DELETE Delete a ticket type shipping method

POST Bulk delete ticket type shipping methods

Ticket Types

GET List ticket types

POST Create ticket type

GET Get ticket type by ID

DELETE Delete ticket type

PATCH Update ticket type

GET List ticket type tags

GET GET /api/v2/ticket-type

GET GET /api/v2/ticket-type/{id}

GET GET /api/v2/ticket-type/get-name

Unregistered Customers

GET Get a list of unregistered customers

GET Get an unregistered customer by ID

DELETE Delete an unregistered customer

POST Bulk delete unregistered customers

POST Send email to unregistered customers

POST Get preview of email count that will be sent

VatSettings

GET Get VAT settings

PATCH Update VAT settings

Waivers

GET Get waivers

POST Create a new waiver

GET Get waiver by ID

DELETE Delete a waiver

PATCH Update a waiver

POST Delete multiple waivers

WaveTimes

GET Get wave times

POST Create a new wave time

GET Get wave time by ID

DELETE Delete a wave time

PATCH Update a wave time

Webhooks

GET List webhooks

POST Create webhook

GET Get webhook by ID

DELETE Delete webhook

PATCH Update webhook

POST Delete multiple webhooks

GET Find Webhook by Id

DELETE Delete one Webhook by Id

PATCH Update Webhook by Id

GET Find a list of Webhooks by a set of filters

POST Create Webhook

GET Run a Webhook of a specific type

WebhookTypes

GET Get webhook types

SettingsWristbandPrinting

GET Get wristband printing settings

PATCH Update wristband printing settings

Zaps

GET List zaps

POST Create zap

GET Get zap by ID

DELETE Delete zap

PATCH Update zap

POST Delete multiple zaps

Auth0

POST Get Auth0 authorization URL

POST Get Auth0 authorization URL for TicketSocket users

GET Auth0 callback handler

GET Get current user profile

GET Get current user profile (deprecation test)

POST Logout current user

POST Refresh authentication token

POST Legacy login (bypasses Auth0)

POST Legacy logout (bypasses Auth0)

POST Request password change via Auth0

POST Change password for legacy authenticated users

POST Request password reset email for legacy users

POST Reset password using token from email

Documentation

GET GET /api/v2/openapi.json

GET GET /api/v2/docs.json

GET GET /api/v2/docs.yaml

Authorization Token

POST Generate a JWT token from a username and password

POST Generate a JWT token from a username and password

GET Check validity of an authorization token

BibAssignmentRules

GET Find BibAssignmentRule by Id

DELETE Delete one BibAssignmentRule by Id

PATCH Update BibAssignmentRule by Id

GET Find a list of BibAssignmentRules by a set of filters

POST Create BibAssignmentRule

Cart

POST From a json order description, build the cart items list

GET GET /api/v2/cart/build-cart-items-from-order-id

POST Process the cart data to describe what order would be created with it

Check-In

GET Get ticket data for scanning purposes

Custom Dashboard

GET Get custom dashboards

POST Create a custom dashboard

DELETE Deletes an existing custom dashboard

PATCH Updates an existing custom dashboard

Customer Authorization Token

POST Generate a JWT token from a customer username and password

GET Check validity of a customer authorization token

Customer

GET Returns the customer's user information

DELETE Deletes an existing customer.

PATCH Updates an existing customer.

GET Retrieves a list of customers.

POST Adds a new customer.

Email Manager

GET Retrieve the list of email templates

POST Create an email template

GET Retrieve a specific email template

POST Send an Email

POST Send an Email from a template

Export Profiles

GET GET /api/v2/export-profile/

GET Find Export Profile by ID

GET Get the columns of an export profile

POST Get the count of records for a set of filters

POST Generate a report using an export profile

FGL Template

GET Get FGL templates

POST Create a fgl template

GET Get FGL signature for FGL print

GET Get FGL certificate

DELETE Deletes an existing fgl template

PATCH Updates an existing fgl template

GET Get FGL template commands

GET Get an FGL template command

POST Create a command for an fgl template

DELETE Deletes an existing fgl command

PATCH Updates an existing fgl command

Fees

POST Calculate the service fee for a given amount (front or backend)

POST Calculate the service fee for a given amount (front or backend)

POST Calculate the service fee for a given amount (front or backend)

POST Calculate the fee1 (usually tax) for a given ticketType and amount

POST Calculate the fee2 (usually gratuity) for a given ticketType and amount

Invites

GET Find Invites

POST Create a new Invite

GET Find Invite by Id

Localization

GET Finds a locationzation by name

POST Adds new phrases for a localization.

PATCH Updates existing phrase for a localization.

GET Finds a locationzation by name

DELETE Delete existing phrases for a localization.

GET Searches the list of localization.

POST Adds an existing location.

GET Finds a locationzation by id

DELETE Deletes an existing location.

PATCH Updates an existing location.

GET List of available phrase names

My Account

GET Returns the customer's information.

PUT Log in to the customer's account. Return's an auth token that can be used with remaining my account end points.

POST Create an account. Requires the caller be an admin that is part of the customer group.

PATCH Update account information.

GET List of the events the customer has access to.

GET List of the ticket types for an event.

GET List of the wave times for an event.

GET Returns the list of orders.

GET Returns the account's payment processor.

GET Returns the account's payment processor.

PUT Sends an email to user.

Order Note

GET Find order note by Id

GET Find a list of order notes by a set of filters

POST Create note for an order

Payments

POST Process a payment method

Payment Processors

GET Return auth code to connect Stripe's SDK

GET Return the list of terminals associted with the stripe account.

Print Template

GET Get Print Templates

POST Create a print template

GET Get Print signature for Print print

GET Get Print certificate

DELETE Deletes an existing print template

PATCH Updates an existing print template

GET Get Print Template commands

GET Get an Print Template command

POST Create a command for an print template

DELETE Deletes an existing print command

PATCH Updates an existing print command

GET Render the Print Code from the template using the data from the ticketId specified

Reports

POST Generate a sales by event report

POST Generate a sales by ticket type report

POST Generate a merchandise report

POST Generate a Refund Protect report

Shared Inventory Groups

GET GET /api/v2/shared-inventory-group/

Shipping Method

GET GET /api/v2/shipping-method/

GET Returns the requested shipping method.

DELETE Deletes the requested shipping method.

PATCH Updates an existing shipping method.

POST Add a new shipping method.

POST Returns multiple shipping methods by id.

POST Adds multiple shipping methods.

POST Updates multiple shipping methods.

POST Deletes multiple shipping methods.

Shopping Cart

GET Returns the settings for the shopping cart.

POST Adds tickets to the cart.

POST Creates a new shopping cart

POST Adds tickets to the cart.

PUT Sets the price of a ticket.

PUT Sets the price of an addon.

PUT Returns the shipping methods available for the indicated tickets.

PUT Sets the shipping method for the ticket.

POST Removes the ticket from the cart.

PUT Set the purchaser.

PUT Set the attendee.

PUT Returns the questions for tickets

PUT Sets the answer for a ticket

PUT Set the billing info.

PUT Returns the questions for tickets

PUT Sets the answer for the order

PUT Sets the price of an addon.

PUT Returns the shipping methods available for all the tickets.

PUT Applies promo codes to the cart.

POST Applies shipping method to multiple tickets.

POST Removes tickets from the cart.

POST Cancels the cart.

PUT Returns the cart's details.

POST Starts the checkout process.

Tax Manager

GET Gather the current line items from cart

POST Calculate taxes based on describe order data

GET Find Tax Details by Transaction Id

Tax Type

GET Find an item's Tax Type

Third Party Accounts

GET Gets the list of Third Party Account.

POST Adds an additional third party account.

GET Gets the given Third Party Account.

DELETE Deleted a third party account.

PATCH Updates a third party account.

Upload

POST POST /api/v2/upload

DELETE DELETE /api/v2/upload

POST POST /api/v2/upload/bulk

Utilities

GET Get the currencies currently supported

GET Get the display name of a currency

GET Round an amount of a currency

Validator

POST Validate International Address

Wallets

GET GET /api/v2/wallet/apple/{orderId}

GET GET /api/v2/wallet/google/{orderId}

Wave Times

GET Returns a list of wave times.

POST Adds a new wave time.

GET Returns the given wave time.

GET Returns the given wave times for the given event.

GET Returns the given wave times for the given ticket type.

DELETE Deletes the given wave time.

PATCH Updates an existing wave time.

On this page

Welcome

This site documents the Premiere V2 API. Browse groups and endpoints from the sidebar to see paths, parameters, request bodies, and responses.

Pager

Next pageAccessPackages