Get access packages
Create a new access package
Get access package by ID
Delete an access package
Update an access package
Update an existing access package
Authorizations
Parameters
Path Parameters
ID of the access package to update
"int64"Request Body
Responses
Access package updated
Administrators
Endpoints to interact with administrators
Operations
List administrators
Create administrator
Get administrator by ID
Delete administrator
Update administrator
Delete multiple administrators
GET /api/v2/administrator/login-report
Get the permission for the current admin user.
Login a user into the v2 api.
Authorizations
Parameters
Query Parameters
Adds additional details to the results. Supports the following values:
- user - Include additional information about the user login in.
- perms - Include permssions for the user login in
Request Body
Responses
Information for the user who's signin in.
Updates the current administrator's password.
List administrator groups
Create administrator group
Get administrator group by ID
Delete administrator group
Update administrator group
Update an existing administrator group
Authorizations
Parameters
Path Parameters
Administrator Group ID
"int64"Request Body
Responses
Updated administrator group
List affiliates
Create affiliate
Get affiliate by ID
Delete affiliate
Update affiliate
Delete multiple affiliates
Get all appearance settings
Update all appearance settings
Attendee Questions
Endpoints to manage attendee questions for events.
Operations
List Attendee Questions
Returns a list of attendee question for an event
Authorizations
Parameters
Path Parameters
Event Id
"int64"Query Parameters
Question ID
"int64"Ticket Type ID
"int64"Responses
Attendee Question list
Create attendee question
Create a attendee question for an event
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Responses
Created attendee question
Get Attendee Question by ID API Endpoint
Delete attendee question
Delete a attendee question
Authorizations
Parameters
Path Parameters
Event ID
"int64"Attendee Question ID
"int64"Responses
Attendee question deleted successfully
Update ordering of attendee question
Update ordering of attendee question
Authorizations
Parameters
Path Parameters
Event ID
"int64"Id of the attendee question to update
"int64"Request Body
Responses
Updated attendee question
Create multiple attendee question
Create multiple attendee question for an event
Authorizations
Parameters
Path Parameters
Event ID
"int64"Ticket type ID
"int64"Request Body
Responses
Created multiple attendee question
Delete multiple attendee questions
Deletes multiple attendee questions
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Responses
Attendee Questions deleted successfully
Get badge printing settings
Update badge printing settings
Partial update. Accepts application/json or multipart/form-data. topImage is upload-only in multipart requests and stored as public URL.
Authorizations
Request Body
Responses
Settings updated successfully
Settings
Endpoints to interact with settings
Operations
Get Box Office settings
Update Box Office settings
Get Receipt settings
Update Receipt settings
Get E Tickets settings
Update Tickets settings
Find Settings by Name
Delete one Settings by Setting Name
Update a setting
Find a list of Settings by a set of filters
Returns a list of Settings
Authorizations
Parameters
Query Parameters
Set the max number of objects to return
"int64"Set the number of objects to ignore before starting
"int64"This will only return setting names that contain the string supplied. You can search for multiple values by using a comma (',') as a seperator
search by setting name
search by setting value
group search can search for multiple values separated by comma and will return all settings within each setting group
Responses
Create Settings
Set the value of a global setting
Get bulk pricing rules
Returns a list of bulk pricing rules for an event
Authorizations
Parameters
Path Parameters
Event Id
"int64"Responses
Bulk pricing rule list
Create a new bulk pricing rule
Create bulk pricing rule
Authorizations
Parameters
Path Parameters
Event Id
"int64"Request Body
Responses
Created bulk pricing rule object
Get bulk pricing rule by ID
Returns a single bulk pricing rule
Authorizations
Parameters
Path Parameters
Event Id
"int64"Bulk pricing rule Id
"int64"Responses
Bulk pricing rule object
Delete a bulk pricing rule
Delete a bulk pricing rule
Authorizations
Parameters
Path Parameters
Event Id
"int64"Bulk pricing rule Id
"int64"Responses
Bulk pricing rule deleted successfully
Update a bulk pricing rule
Update an existing bulk pricing rule
Authorizations
Parameters
Path Parameters
Event Id
"int64"Bulk pricing rule Id
"int64"Request Body
Responses
Updated bulk pricing rule object
Get categories
Create a new category
Get category by ID
Delete a category
Update a category
Update an existing category
Authorizations
Parameters
Path Parameters
Category Id
"int64"Request Body
Responses
Updated category object
Get category groups
Create a new category group
Get category group by ID
Delete a category group
Update a category group
Update an existing category group
Authorizations
Parameters
Path Parameters
Category Group Id
"int64"Request Body
Responses
Updated category group object
Scan overview by event and ticket type
Authorizations
Parameters
Query Parameters
Filter by ticket types. Expected comma-separated event ID(s).
Filter by ticket types. Expected comma-separated ticket type ID(s).
Responses
Flat list of scan overview rows (one per event and ticket type), including eventName
Scan details by administrator and scan type
Authorizations
Parameters
Query Parameters
Filter by scan date more than or equal to this date.
Filter by scan date less than or equal to this date.
Filter by ticket types. Expected comma-separated event ID(s).
Filter by ticket types. Expected comma-separated ticket type ID(s).
Filter by administrator ID who scanned tickets.
Responses
Per-administrator rows with flat scanDetails (scan kind, ticket type id/name, unique tickets, total scans)
Get all checkout settings
Update all checkout settings
ConnectJobs
Endpoints to interact with connectJobs
Operations
List connect jobs
Paginated jobs for the authenticated organizer scope. Optional eventId filters by event.
Authorizations
Parameters
Query Parameters
Responses
Connect job list
Create connect job
Creates a job and recipient rows. Barcodes apply only to email blast + upload-list target. waveTimeIds is validated only when the site wave-time tab participant setting is enabled.
Authorizations
Request Body
Responses
Created
Get connect job by id
Delete connect job (soft delete)
Update connect job
Updates schedule (startTime), disabled flag, and/or Connect email template. Unknown JSON keys are rejected (strict validation).
Authorizations
Parameters
Path Parameters
Request Body
Responses
Updated job
List recipients for a connect job
Paginated recipient rows for the job; optional status filters by recipient status.
Authorizations
Parameters
Path Parameters
Query Parameters
"completed""queued""failed"Responses
Paginated recipients (ConnectRecipientFormatter: status as lowercase string, orderId from objectId)
Start connect job run (legacy runner, asynchronous)
Dispatches the same admin connect runJob URL used by cron; returns immediately while sending continues in the background.
Authorizations
Parameters
Path Parameters
Responses
Run triggered; poll job/recipients for progress
Find ConnectJob by Id
Delete one ConnectJob by Id
Update ConnectJob by Id
Find a list of ConnectJobs by a set of filters
Returns a list of ConnectJobs
Authorizations
Parameters
Query Parameters
Set the max number of objects to return
"int64"Set the number of objects to ignore before starting
"int64"text string that will search certain text fields
comma separated list of items to select ('connectJobs.*, event.name')
eventId
"int64"Name of Connect Job
subject
Time submitted
"int64"ConnectJob Type Id
Responses
Create ConnectJob
Find ConnectJob Members by Id
List customers
Get a list of customers
Authorizations
Parameters
Query Parameters
100Responses
A list of customers
Create customer
Get customer
Delete customer
Update customer
Bulk delete customers
Export customers as CSV
Downloads a CSV file containing customer details matching the given filters.
Authorizations
Parameters
Query Parameters
Filter by customer type (regular, guest, prospect)
"regular""guest""prospect"Filter by event status (purchased, unpurchased)
"purchased""unpurchased"Event IDs filter (upcoming, elapsed, or comma-separated IDs)
Responses
CSV file download with customer details.
Get default localization
Update default localization
Updates the default localization ID and returns the localization object
Authorizations
Request Body
Responses
Default localization updated, returns localization object
List email templates
Create email template
Get email template by ID
Delete email template permanently
Update email template
Duplicate email template
Events
Endpoints to interact with events
Operations
Get Events API Endpoint
Authorizations
Parameters
Query Parameters
Filter by from date
"2021-01-01"Filter by to date
"2021-01-01"Comma-separated. Core: published, elapsed (event ended: end < now), not_on_sale (onSale=0), archived, unpublished (published=0), invite_only. scheduled (onSaleDate in future), on_sale (onSale=1 or onSaleDate has passed), sold_out (v1: sum(soldCount) >= sum(quantity) excluding tier-linked types), pending (custom field pendingStatus=1; v1 Pending Status column), approved (else branch; not pendingStatus=1).
"published,on_sale"Include related and additional data by total_ticket_sold,total_ticket,ticket_types
"ticket_types"Comma-separated category IDs (system_plug_eventManager_selectedCategories.categoryId). Returns events linked to any of the listed categories.
"1,2"Responses
Question list
Create a new event
Create event. Supports both JSON and multipart/form-data for file uploads.
Authorizations
Request Body
PHP date format string for end time display
Date when event was published (Unix timestamp format)
Custom formatted start date string for display
Whether the event is published and visible
Whether the event is featured/highlighted
Numeric sort order of the event in lists (lower = first)
Whether the event is currently on sale
Whether the event requires an invitation to register
Event title
Search engine friendly URL slug
Full event description
Short event description
Text to display when event is not on sale
Whether to skip this event in public lists
Whether to skip this event in API lists
Event start timestamp (Unix timestamp)
Event end timestamp (Unix timestamp)
PHP date format string for start date display
Date when tickets go on sale (Unix timestamp)
Registration cutoff timestamp (Unix timestamp)
Maximum number of tickets available
Venue name
Venue address line 1
Venue address line 2
Venue city
Venue state/province
Venue postal/zip code
Venue country
Whether to display venue name
Whether to display venue address line 1
Whether to display venue address line 2
Whether to display venue city
Whether to display venue state
Whether to display venue postal code
Venue latitude coordinate
"float"Venue longitude coordinate
"float"upload file image
upload file image
Custom URL path to override the default event URL
Whether to display the registration cutoff date
Organization or person presenting the event
Whether a promo code is required for registration
Whether to hide this event in the box office
Whether to display an embedded map for the venue
Whether the wave time selector is shown as the first purchase question
When true, captains cannot sign waivers on behalf of other attendees (event-level, v1 parity).
Receipt emails data
Receipt text data
event tag, Example request: eventTags[0], eventTags[1]
Event select multiple categories
Responses
Created event
GetEvent by ID API Endpoint
Delete Event by ID
Update event
Update event by Id. Supports both JSON and multipart/form-data for file uploads.
Authorizations
Parameters
Path Parameters
Events Id
"int64"Request Body
PHP date format string for end time display
Date when event was published (Unix timestamp format)
Custom formatted start date string for display
Whether the event is published and visible
Whether the event is featured/highlighted
Numeric sort order of the event in lists (lower = first)
Whether the event is currently on sale
Whether the event requires an invitation to register
Event title
Search engine friendly URL slug
Full event description
Short event description
Text to display when event is not on sale
Whether to skip this event in public lists
Whether to skip this event in API lists
Event start timestamp (Unix timestamp)
Event end timestamp (Unix timestamp)
PHP date format string for start date display
Date when tickets go on sale (Unix timestamp)
Registration cutoff timestamp (Unix timestamp)
Maximum number of tickets available
Venue name
Venue address line 1
Venue address line 2
Venue city
Venue state/province
Venue postal/zip code
Venue country
Whether to display venue name
Whether to display venue address line 1
Whether to display venue address line 2
Whether to display venue city
Whether to display venue state
Whether to display venue postal code
Venue latitude coordinate
"float"Venue longitude coordinate
"float"upload file image
upload file image
Custom URL path to override the default event URL
Whether to display the registration cutoff date
Organization or person presenting the event
Whether a promo code is required for registration
Whether to hide this event in the box office
Whether to display an embedded map for the venue
Whether the wave time selector is shown as the first purchase question
When true, captains cannot sign waivers on behalf of other attendees (event-level, v1 parity).
Receipt emails data
Receipt text data
event tag, Example request: eventTags[0], eventTags[1]
Event select multiple categories
Array of waiver IDs required on the standard waiver
Array of waiver IDs required on the day of the event
Responses
Updated events object
List ticket type tags
Duplicate event
Duplicate event by Id and return the new event. JSON body requires title, sefUrl, start, and end; optional cutOff, timezone, and processorId.
Authorizations
Parameters
Path Parameters
Source event ID to duplicate
"int64"Request Body
Responses
Duplicate event
Find Event by ID
Find events that match the provided input parameters
Authorizations
Parameters
Query Parameters
Search text in just the title - must match exactly unless you use a % to match any char
Search text in Title, Description, Venue, Venue Address - uses wildcard search
Includes events whose start date is on or after the provided date and time. Value should be a unix timestamp in UTC.
Includes events whose start date is before the provided date and time. Value should be a unix timestamp in UTC.
Includes events whose ending date is on or after the provided date and time. Value should be a unix timestamp in UTC.
Includes events whose ending date is before the provided date and time. Value should be a unix timestamp in UTC.
Filters events based on if they've been marked as onsale. This filter ignores an event's end date and cutoff. If toEnd isn't includes then past events will still be included.
- all - Matches all events.
- onsale - Only events that are currently marked as onsale.
- upcoming - Only events that have been scheduled to be onsale in the future.
- onsaleupcoming - Events that are currently marked as on sale and events that have been schedule to be marked as on sale.
- offsales - Event that have been marked as offsale.
Filters events based on if they've been published.
- all - Matches all events.
- published - Only events that are currently published.
- upcoming - Only events that have been scheduled to be published in the future.
- publishedupcoming - Events that are currently marked as published and events that have been schedule to be marked as published.
- unpublished - Event that have been marked as published.
Filters events based on the select critera. If provided then onsale, published, and the date filters will be ignored.
- all - Matches all events.
- availableonline - Currently available for purchase online.
- upcomingonline - Only events that have been scheduled to be on sale in the future online.
- availableupcomingonline -Events that currently on sale online or are upcoming.
- availableboxoffice - Currently available for purchase via the box office.
- upcomingboxoffice - Evants that are upcoming for purchase via the box office or are upcoming.
- availableupcomingboxoffice - Currently available for purchase via the box office or are upcoming.
- upcoming - All events who's start date is in the future.
- ongoing - All events who's start date has past but the end date is in the future.
- elapsed - All events who's end date is in the past.
Returns events that have been changed since the provided date. The date is a unix timestamp.
Adds additional details to the results. Supports the following values:
- tags - Include tags.
- waveTimes - Include wave times
- sold - Include tickets sold and total available.
Determins the order the events are returned. Each property can be append with + or -. + indicated sort asc and - sorts deciding. If excluded the column is sorted in asceding sort. Multiple columns a seperated by a comma. You can sort by ordering, title, start, id.
Responses
Create a new event
Create event. Supports both JSON and multipart/form-data for file uploads.
Authorizations
Request Body
PHP date format string for end time display
Date when event was published (Unix timestamp format)
Custom formatted start date string for display
Whether the event is published and visible
Whether the event is featured/highlighted
Numeric sort order of the event in lists (lower = first)
Whether the event is currently on sale
Whether the event requires an invitation to register
Event title
Search engine friendly URL slug
Full event description
Short event description
Text to display when event is not on sale
Whether to skip this event in public lists
Whether to skip this event in API lists
Event start timestamp (Unix timestamp)
Event end timestamp (Unix timestamp)
PHP date format string for start date display
Date when tickets go on sale (Unix timestamp)
Registration cutoff timestamp (Unix timestamp)
Maximum number of tickets available
Venue name
Venue address line 1
Venue address line 2
Venue city
Venue state/province
Venue postal/zip code
Venue country
Whether to display venue name
Whether to display venue address line 1
Whether to display venue address line 2
Whether to display venue city
Whether to display venue state
Whether to display venue postal code
Venue latitude coordinate
"float"Venue longitude coordinate
"float"upload file image
upload file image
Custom URL path to override the default event URL
Whether to display the registration cutoff date
Organization or person presenting the event
Whether a promo code is required for registration
Whether to hide this event in the box office
Whether to display an embedded map for the venue
Whether the wave time selector is shown as the first purchase question
When true, captains cannot sign waivers on behalf of other attendees (event-level, v1 parity).
Receipt emails data
Receipt text data
event tag, Example request: eventTags[0], eventTags[1]
Event select multiple categories
Responses
Created event
Find TicketTypes by Event ID
Returns a list of ticketTypes
Authorizations
Parameters
Path Parameters
Event Id of the TicketTypes to return
"int64"Query Parameters
Limit Results to this number
"int64"Limit Results to this number
"int64"Specific columns to select (else * will be selected)
Responses
Find wave times for the given event.
Scans a ticket for an event.
Scans a ticket for an event.
Authorizations
Parameters
Path Parameters
The id of the event being scanned.
Request Body
Responses
The ticket was successfully scanned.
Scans a ticket for a set of events.
Scans a ticket for a set of events.
Authorizations
Request Body
Responses
The ticket was successfully scanned.
List event gallery images
Returns all gallery images for an event, ordered by their ordering field
Authorizations
Parameters
Path Parameters
Event ID
"int64"Query Parameters
Filter by published status
Responses
List of event images
Upload event gallery image
Upload a new gallery image for an event. Supports both multipart/form-data and base64 JSON uploads.
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Image file to upload
"binary"Optional title for the image
Whether the image is published (default: true)
trueResponses
Image uploaded successfully
Delete event gallery image
Bulk delete event gallery images
Reorder event gallery images
Reorder gallery images by providing ALL image IDs for the event in the desired order. The position in the array determines the new ordering value (0-based). You must include all image IDs - partial updates are not allowed.
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Responses
Images reordered successfully
Get event shipping methods
Returns a list of shipping methods assigned to the given event, including event-specific settings such as shipping cutoff.
Authorizations
Parameters
Path Parameters
Event ID
"int64"Responses
Paginated list of event shipping methods
Update event shipping method settings
Update event-specific shipping method settings (e.g. shipping cutoff)
Authorizations
Parameters
Path Parameters
Event ID
"int64"Shipping Method ID
"int64"Request Body
Responses
Updated event shipping method
Bulk update event shipping method settings
Update event-specific shipping method settings (e.g. shipping cutoff) for multiple shipping methods.
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Responses
Updated event shipping methods
List all async CSV export jobs
Download a completed async export as CSV
Delete an async export job and its S3 file
FglCommands
Endpoints to interact with FGL commands
Operations
List FGL template commands
Create FGL template command
Create a command for a specific FGL template
Authorizations
Parameters
Path Parameters
FGL Template ID
Request Body
Responses
Created FGL command object
Get FGL template command by ID
Get a single command by ID for a specific FGL template
Authorizations
Parameters
Path Parameters
FGL Template ID
FGL Command ID
Responses
FGL command object
Delete FGL template command
Update FGL template command
Update a command for a specific FGL template
Authorizations
Parameters
Path Parameters
FGL Template ID
FGL Command ID
Request Body
Responses
Updated FGL command object
Bulk delete FGL template commands
List FGL templates
Create FGL template
Get FGL template by ID
Get a single FGL template
Authorizations
Parameters
Path Parameters
FGL Template ID
Query Parameters
Include related resources
"commands"Responses
FGL template object
Delete FGL template
Update FGL template
Bulk delete FGL templates
GeneralSettings
Endpoints to get and update general site settings. Response and request use "general" and "policy" objects. Boolean fields default to false; string fields default to empty string.
Get General settings
Update General settings
Partial update of general settings. Accepts application/json or multipart/form-data with optional adminHeaderPicture file upload (jpeg, png, gif, webp, max 5MB).
Authorizations
Request Body
Responses
Settings updated successfully
Settings / Incomplete Order Email
Incomplete order email settings (promo code, email content, schedule, event filter)
Get Avalara integration settings
Update Avalara integration settings
Get GoFundraise integration settings
Update GoFundraise integration settings
Get RaceResult integration settings
Update RaceResult integration settings
Get Salesforce integration settings
Update Salesforce integration settings
Get Active Campaign settings
Update Active Campaign settings
Search ActiveCampaign lists
Returns lists from the ActiveCampaign API (v1 api/activeCampaignInterface/searchLists parity). Uses site integration API URL and API key. Optional name filter matches v1 filters[name] query.
Authorizations
Parameters
Query Parameters
Filter lists by name (partial match per ActiveCampaign API)
"newsletter"Responses
ActiveCampaign lists
Get i-Connect settings
Update i-Connect settings
Pull orders from i-Connect
Get MailChimp settings
Update MailChimp settings
Get MailChimp email lists
List linked sites
Create linked site
Get linked site by ID
Delete linked site
Update linked site
Delete multiple linked sites
Get localizations
Create localization
Get localization by ID
Delete localization
Update localization
Partial update; only present fields and phrase keys are updated
Authorizations
Parameters
Path Parameters
Localization ID
"int64"Request Body
Responses
Localization updated
Duplicate localization
Creates a copy of the localization and all its phrases
Authorizations
Parameters
Path Parameters
Source localization ID to copy
"int64"Request Body
Responses
Localization duplicated
Delete multiple localizations
Orders
Manages orders
Operations
GET /orders
Get orders
Authorizations
Parameters
Query Parameters
Include related and additional data. Accepted values: order_total, tickets, purchase_questions
"order_total,tickets,purchase_questions"Filter by order status. Accepted values: refunded, partial, checkedIn, purchased, unpaid
"purchased,checkedIn"Filter orders created from this datetime (format: Y-m-d H:i)
"2025-11-05 08:19"Filter orders created up to this datetime (format: Y-m-d H:i)
"2025-11-05 08:25"Filter by a single event ID
2Filter by multiple event IDs (comma-separated)
"1,2"Filter by ticket type ID
3Filter by minimum ticket price paid
100"float"Filter by maximum ticket price paid
200"float"Filter by payment methods (comma-separated). Accepted values: cash,credit,sezzle
"cash,credit"Filter by shipping method IDs (comma-separated)
"1,2"Filter by affiliate ID
286Filter by promo code ID
2Filter by promo code group name
"ICS Promo Code"Filter by admin user ID
1Filter by purchase source (comma-separated). Accepted values: boxOffice, frontEnd, backEnd, presale
"boxOffice,frontEnd"Filter by change status (comma-separated). Accepted value: transferred,eventChange,upgraded,claimed,unclaimed,withdrawn
"eventChange,upgraded"Filter by specific order ID
42962Filter by ticket barcode
"75387482648539"Filter by wave time IDs (comma-separated)
"1,2,3"Filter by last 4 digits of payment card
"4242"Filter by new customer flag (false = returning, true = new)
"false""true""false"Filter by ticket status. Accepted values: purchased, checkedIn, cancelled, refunded
"purchased,checkedIn"Filter orders purchased with a pass (true = yes)
"false""true""true"Include deleted orders (true = include deleted)
"false""true""true"Include all orders including deleted (true = yes)
"false""true""true"Responses
Order list
Get order
Get order by Id
Authorizations
Parameters
Path Parameters
Order Id
"int64"Query Parameters
Include additional data. Accepted values: order_addons
"order_addons"Responses
Order object
Update order
Update order by Id
Authorizations
Parameters
Path Parameters
Orders Id
"int64"Request Body
Responses
Updated orders object
Refund order
Process a refund for an order. Use GET /orders/{id} to retrieve refundable item details.
Authorizations
Parameters
Path Parameters
Order Id
"int64"Request Body
Responses
Refund processed successfully
Resend order email receipt
Resend the order receipt via email. Optionally send to all attendees.
Authorizations
Parameters
Path Parameters
Order Id
"int64"Request Body
Responses
Email receipt sent successfully
Export orders as CSV
Downloads a CSV file containing order summaries matching the given filters.
Authorizations
Parameters
Query Parameters
Filter by event ID. Supports comma-separated multiple values.
Filter by ticket type ID. Supports comma-separated multiple values.
Filter by promo code ID. Supports comma-separated multiple values.
Filter by affiliate ID. Supports comma-separated multiple values.
Filter by payment method.
Filter by purchase location. Supports comma-separated multiple values.
Filter by order status (active, cancelled, refunded, partialCancelled, partialRefunded).
Filter by ticket status (purchased, checkedIn, cancelled, refunded).
Earliest purchase date (inclusive).
Latest purchase date (inclusive).
Responses
CSV file download with order summary rows.
Export tickets as CSV
Downloads a CSV file containing one row per ticket with attendee and cost details matching the given filters.
Authorizations
Parameters
Query Parameters
Filter by event ID. Supports comma-separated multiple values.
Filter by ticket type ID. Supports comma-separated multiple values.
Filter by wave time ID. Supports comma-separated multiple values.
Filter by promo code ID. Supports comma-separated multiple values.
Filter by affiliate ID. Supports comma-separated multiple values.
Filter by bib number. Supports comma-separated multiple values.
Responses
CSV file download with one row per ticket.
Export purchasers as CSV
Downloads a CSV file containing purchaser name, email, and order ID for each matching order.
Authorizations
Parameters
Query Parameters
Responses
CSV file download with purchaser rows.
Export attendees as CSV
Downloads a CSV file containing attendee name, email, and order ID for each ticket in matching orders.
Authorizations
Parameters
Query Parameters
Responses
CSV file download with one row per attendee.
Export shipping details as CSV
Downloads a CSV file containing shipping address information for each ticket in matching orders.
Authorizations
Parameters
Query Parameters
Filter by shipping method ID.
Responses
CSV file download with shipping address rows.
Returns a single order
Returns a single order
Authorizations
Parameters
Path Parameters
The id of the order
Query Parameters
Set to true to include the ticket details.
Include any answer's for both the orders and tickets.
Include costs as part of the order.
Responses
The order was found.
Retrieves a list of orders.
Returns a list of order summaries. Note that filters apply to the orders, not the ticket. If you filter by an event and order has tickets for the filtered event and another both tickets will be returned.
Authorizations
Parameters
Query Parameters
Set the max number of objects to return.
"integer"Set the number of objects to ignore before starting.
"integer"Searchs purchaser's first name, last name, email address as well as the ticket's barcode and order #.
The email address of the purchaser.
The location the order was purchased. Supports multiple values seperated by a comma.
The id of the event tickets where purchased for. Supports multiple values seperated by a comma.
The id of the ticket types that where purchased. Supports multiple values seperated by a comma.
The id of the user who sold the ticket. Supports multiple values seperated by a comma.
The id of the event tickets where purchased for. Supports multiple values seperated by a comma.
The id of the wave time purchase. Supports multiple values seperated by a comma.
The last four of the CC used to pay for the order. Supports multiple values seperated by a comma.
Only include orders with a ticket that matches the bib number. Supports multiple values seperated by a comma.
The payment method used to purchase the order.
The id's of the promo code that was applied to the order. Supports multiple values seperated by a comma.
The names's of the promo code group that was applied to the order. Supports multiple values seperated by a comma.
Filter by the order's status. Acceptable values are active, cancelled, refunded, paritalCancelled, or partialRefunded.
Filter by the order change status. Acceptable values are transferred, upgraded, claimed, unclaimed, withdrawn, or eventChange.
Filter by the ticket's status. Acceptable values are purchased, checkedIn, cancelled, or refunded.
The id of affilate associated with the order. Supports multiple values seperated by a comma.
Filter by the shipping method id.
Pass true to limit search for to orders that were purchased with a pass.
Filters based on if refund proctected was purchased and type. Supports the following values opted-in, opted-out, meetch, or refundProtect.
The earliest date the order was purchased.
The latest date the order was purchased.
The earliest date the order was updated.
The latest date the order was updated.
The lowest listed price for a ticket when purchased.
The highest lised price for a ticket when purchased.
The lowest price currently paid for a ticket.
The highest price currently paid for a ticket.
The lowest price originally paid for a ticket.
The highest price originally paid for a ticket.
Select the format of the returned data. If the parameter is not provided the default format is standard. Can be one of the following:
- attendees - A csv containing the list of matching attendees.
- purchasers - A csv containing the list of matching purchasers.
- tickets - A csv containing the list of matching tickets.
- orders - A csv contain the list of matching orders.
- shipping - A csv contain shipping information for the matching orders.
- standard - Json contain the selected data.
Adds additional details to the results. Ignored if format is any other then standard. Multiple options can be include seperated by a comma. Supports the following values:
- answers - Include answers to questions.
- tickets - Include ticket information.
- promoCodes - Include promo codes used.
- hash - Include order hash.
- costs - Include cost information.
- purchaseProtected - Include purchase protect information.
- allTicketsForOrder - Include all tickets for order ignoring fileters.
- ticketCount - Include the number of tickets per order.
- change - Include orders id of new/old orders.
- promoter - Include the ticket's promoter.
- waveTime - Include the wave time id (if any).
- waivers - Includes signed waivers attached to the ticket (if any).
- user - Include user information.
Responses
A list of matching orders.
Creates an order once payment has been verified.
Creates an order based on the cart created via the shopping cart end points. The order is only created after payment has been verified.
Authorizations
Request Body
Responses
The order was created after payment was successfully. The order is only included if result is order.
Scan all tickets in an order.
Scans all tickets in an order.
Authorizations
Parameters
Path Parameters
The id of the order.
Request Body
Responses
The order was successfully scanned.
Process the cart data to describe what order would be created with it
Complete a staged order and run the after order processes
OrdersSettings
Orders settings (incomplete order email, upgrade ticket, change order, ticket transfer, send to a friend)
Get orders settings
Authorizations
Parameters
Query Parameters
Return only the specified sub-setting object
"incompleteOrder""upgradeTicket""changeOrder""ticketTransfer""sendToFriend"Responses
Orders settings
Update orders settings
List organizers
Create organizer
Get organizer by ID
Delete organizer
Update organizer
Delete multiple organizers
Get outgoing email settings
Update outgoing email settings
SettingsPaymentProcessors
Endpoints to manage payment processor settings
Operations
Get OAuth authorization URL for Stripe or Square Connect
Manually set connect access code (TicketSocket users only)
Disconnect Stripe or Square Connect
Get payment processors settings
Update payment processors settings
Get available Stripe locations
Get available Square locations
Get available Stripe terminals
Promo Codes
Endpoints to interact with promo codes
Operations
Get a list of promo codes
Authorizations
Parameters
Query Parameters
Filter by status
"active""inactive""soldOut""expired""active"Filter by type
"specific""percentage""flat""specificTag""percentage"Responses
Promo code list
Create promo code
Get promo code by ID
Delete promo code
Update promo code
Bulk delete promo codes
Upload promo code import file (step 1)
Upload CSV/TXT for a two-step import. Returns importId, column headers or synthetic names, preview rows, and row count. File is stored in private storage until confirm or expiry.
Authorizations
Request Body
CSV or TXT file
"binary"Treat first row as column headers
falseMax preview rows (1–100)
20Responses
Upload result
Confirm promo code import (step 2)
Apply column mapping and defaults, create or optionally update promo codes (or stored value codes when defaults.type is "storedValue") from the staged CSV. If any row fails (failed > 0), the upload session is kept so you can call confirm again with the same importId (e.g. set overwriteDuplicate to true after duplicate errors). On full success (failed === 0), the staged file and session are removed.
Authorizations
Parameters
Path Parameters
Session id returned by POST /api/v2/promo-codes/import/upload
"uuid"Request Body
Responses
Import result
Export filtered promo codes to CSV (zipped)
Creates a UTF-8 CSV inside a ZIP, uploads to private storage, and optionally emails a Global Export Manager download link. Filters mirror v1 promoCodeManager apiExportCsv: search on code and codeGroup, expired toggles rows with activeTo before now versus on or after now, excludes storedValue types.
Authorizations
Parameters
Query Parameters
Search text (code and codeGroup).
"SUMMER"If true, rows where activeTo < now; if false, activeTo >= now. Omit or false for active export.
falsefalseRecipient for download link email; if omitted, v1-style defaults apply.
"reports@example.com""email"Responses
Export created; use downloadUrlPath with site origin or email link
Get a list of promo codes
Authorizations
Parameters
Query Parameters
Filter by status
"active""inactive""soldOut""expired""active"Filter by type
"specific""percentage""flat""specificTag""percentage"Responses
Promo code list
Get promo code by ID
Create promo code
GET /api/v2/promo-code/{id}/applies-to-ticket-type
GET /api/v2/promo-code/{id}/calculate-discount
Authorizations
Parameters
Path Parameters
ID of promo code to use
"int64"Query Parameters
Ticket type to apply discount to
"int64"Original price
"float"Already applied amount
"int64"Responses
List public keys
Create public key
Get public key by ID
Delete public key
Update public key
Delete multiple public keys
Get Public site settings
Uses v2-only PublicSettingSite::getPublicSettings() - same logic as v1:
latest system_settings (order by timestamp desc limit 1), then customFields
where settingsId = that id.
Authorizations
Responses
Public setting object
PurchaserQuestionReport
Purchaser question sales report endpoints for summary, charts, and question breakdown
Get full question breakdown table with per-answer stats
Get purchaser question report summary (gross revenue, question count, answer count)
Get per-day question revenue for charting
Export purchaser question report as CSV (sync) or enqueue to S3 + DB (async)
Get QZ Printing settings
Update QZ Printing settings
Get questions
Returns a list of questions
Authorizations
Parameters
Query Parameters
Filter questions by types
Filter questions by group ID
1Responses
Question list
Create a new question
Get question by ID
Returns a single question
Authorizations
Parameters
Path Parameters
Question Id
"int64"Query Parameters
To include localized question and answer. Example: ?localizations=en,fr, ?localizations=* for all available localizations
Responses
Question object with relation answers, group, and tags
Delete a question
Update a question
Delete multiple questions
Get question localizations
Get question groups
Create a new question group
Get question group by ID
Delete a question group
Update a question group
Update an existing question group
Authorizations
Parameters
Path Parameters
Group Id
"int64"Request Body
Responses
Updated question group object
Get sales report summary (revenue, transactions, tickets sold)
Get per-day ticket value aggregation for charting
Get sales datatable (per-event breakdown with fees)
Get transaction datatable (per-transaction line items)
Get revenue datatable (per-event revenue metrics)
Get VAT datatable (per-transaction VAT breakdown)
Export a report type as a downloadable CSV
Get shipping methods
Create a new shipping method
Get shipping method by ID
Delete a shipping method
Update a shipping method
Update an existing shipping method
Authorizations
Parameters
Path Parameters
ID of the shipping method to update
"int64"Request Body
Responses
Shipping method updated
Delete multiple shipping methods
Get a list of stored value codes
Authorizations
Parameters
Query Parameters
Filter by status
"active""inactive""soldOut""expired""active"Filter by expired codes (true/1 for expired, false/0 for active)
"true"Responses
Stored value code list
Create stored value code
Get stored value code by ID
Delete stored value code
Update stored value code
Update stored value code by id in request body
Authorizations
Parameters
Path Parameters
Stored value code ID
"int64"Request Body
Responses
Stored value code updated
Bulk delete stored value codes
Get a list of stored value codes
Authorizations
Parameters
Query Parameters
Filter by status
"active""inactive""soldOut""expired""active"Filter by expired codes (true/1 for expired, false/0 for active)
"true"Responses
Stored value code list
Get stored value code by ID
Create stored value code
List teams
List teams with optional search, sort, and includes
Authorizations
Parameters
Query Parameters
Filter by event ID
Comma-separated: tickets, event
"tickets,event"Responses
Paginated team list
Create team
Get team by ID
Delete team
Update team
Bulk delete teams
Bulk remove tickets from a team
Unassigns tickets from the team (sets teamId to 0). If the team captain is removed, captain is cleared.
Authorizations
Parameters
Path Parameters
Request Body
Responses
Tickets unassigned
Find Team by Id
Delete one Team by Id
Update Team by Id
Find a list of Teams by a set of filters
Returns a list of Teams
Authorizations
Parameters
Query Parameters
Set the max number of objects to return
"int64"Set the number of objects to ignore before starting
"int64"text string that will search certain text fields
comma separated list of items to select ('tickets.*, ticketTypes.name')
eventId
"int64"teamName
teamUrl
captain
"int64"created
"int64"teamType
fundraisingGoal
"float"anonymous
"int64"image
teamText
crowdriseTeamId
captainsTicketId
"int64"guid
Responses
Create Team
Find Team Members by Id
Report Templates
Endpoints to manage and export report templates
Operations
Get report templates
Create a report template
List Basic Info field keys and default labels for report templates
Returns the same field list as the admin export manager Basic Info picker. When USAT is enabled for the site, USAT-only fields are included at the end.
Authorizations
Responses
Field list
Get report template by ID
Delete a report template
Update a report template
Duplicate a report template
Bulk delete report templates
Export data using selected report template(s)
Tickets
Endpoints to interact with tickets
Operations
Get tickets
Returns a list of tickets
Authorizations
Parameters
Query Parameters
Filter by event ID
Filter by event ID(s). Comma-separated list, e.g. 2,3.
Filter by team ID(s). Comma-separated list, e.g. 0,5 for unassigned (0) or assigned to team 5
"0,5"Filter by ticket types ID(s). Comma-separated list, e.g. 2,3.
"2,5"Exclude tickets with these processState values (comma-separated). Use 4 to omit cancelled tickets (valid/sold list).
"4"Comma-separated optional expansions: change_status (ticketClaim), ticket_status (ticketRefund), purchaser (nested purchaser contact fields), checkInInfo (nested scannedTimestamp for display parity with attendee check-in UI)
"purchaser,checkInInfo"Responses
Ticket list
Check-in and sold stats for events
Returns aggregate sold ticket count (SUM of ticketTypeSoldCount for types on the given events, same as Event Manager) and checked-in ticket count matching v1 attendee check-in: eligible tickets (not cancelled, transferred, or withdrawn) with processState checked-in or a non-deleted access-package scan for one of the events.
Authorizations
Parameters
Query Parameters
Comma-separated event IDs (required)
"1,2,3"Responses
Sold and checked-in counts for the requested events
GET /tickets/{id}
Authorizations
Parameters
Path Parameters
Ticket Id
"int64"Query Parameters
Comma-separated optional expansions: change_status, ticket_status, purchaser, checkInInfo (same as GET /tickets)
"purchaser,checkInInfo"Responses
Ticket object
DELETE /tickets/{id}
Update ticket
Update ticket by Id
Authorizations
Parameters
Path Parameters
Ticket Id
"int64"Request Body
Responses
Updated ticket object
Check in ticket
Check in a ticket by ID. Implements attendee check-in parity with v1 (simple or access-package scans) in v2 code. Body must be empty; administrator identity comes from the JWT.
Authorizations
Parameters
Path Parameters
Ticket Id
"int64"Responses
Ticket checked in; returns the ticket resource (same as GET /tickets/{id})
Upload ticket profile photo
Upload attendee profile photo (multipart). Stored as public URL on the ticket.
Authorizations
Parameters
Path Parameters
Ticket Id
"int64"Request Body
"binary"Responses
Ticket with profilePhoto set
Delete ticket profile photo
Remove stored profile photo URL from the ticket (best-effort delete of public object).
Authorizations
Parameters
Path Parameters
Ticket Id
"int64"Responses
Ticket with profilePhoto cleared
Delete multiple tickets
GET /api/v2/ticket
Authorizations
Parameters
Query Parameters
Limit to tickets in this order
Limit to tickets for this event
Limit to tickets of this type
Limit to tickets for this customer
Limit to tickets matching this barcode
Limit to tickets matching this search string
Limit to tickets purchased after this date/time
Limit to tickets purchased before this date/time
Limit to tickets updated after this date/time
Limit to tickets updated before this date/time
Limit tickets to this number
"int64"Limit tickets to this number
"int64"Adds additional details to the results. Multiple options can be include seperated by a comma. Supports the following values:
- costs - Include costs details.
- refundProtect - Include refund protect information
- change - Include ticket id of new/old ticket.
- promoter - Include the ticket's promoter.
- waveTime - Include the wave time id (if any).
- waivers - Includes signed waivers attached to the ticket (if any).
- user - Include user information.
Responses
Find Ticket by ID
Find Answers for Attendee questions on tickets
Pull the claim info for a given ticket either by ticketId or (id of the claim record - less likely)
Find out if a ticket has was sent as a claim or not
Find out if a ticket has been claimed or not
Modify the claimant email for a given ticket claim
POST /api/v2/ticket/{ticketId}/claim
Check if a bib number is available for a ticket
Returns whether the provided bib is available for the given ticket.
Authorizations
Parameters
Path Parameters
Ticket ID
"int64"Bib number to check
"int64"Responses
Bib availability result
POST /api/v2/ticket/{ticketId}/states
Get ticket groups
Returns a list of ticket groups
Authorizations
Parameters
Path Parameters
Event Id
"int64"Responses
Ticket group list
Create a new ticket group
Get ticket group by ID
Returns a single ticket group
Authorizations
Parameters
Path Parameters
Event Id
"int64"Ticket Group Id
"int64"Responses
Ticket group object
Delete a ticket group
Deletes a ticket group
Authorizations
Parameters
Path Parameters
Event Id
"int64"ID of the ticket group to delete
"int64"Responses
Ticket group deleted successfully
Update a ticket group
Update an existing ticket group
Authorizations
Parameters
Path Parameters
Event Id
"int64"ID of the ticket group to update
"int64"Request Body
Responses
Updated ticket group object
TicketImports
CSV ticket import: upload file, map columns, preview, and run import (update existing or create new tickets).
List ticket imports
Create ticket import
Get mapping fields
Get ticket import by ID
Delete ticket import
Removes the CSV file from storage. If status is not completed (e.g. drafting, processing, failed), the ticket import record is also deleted. If status is completed, only the file is removed and the record is kept (s3Key cleared). Returns 400 if the file could not be removed from storage.
Authorizations
Parameters
Path Parameters
Responses
Ticket import and/or file deleted successfully
Update ticket import
Save column mapping for the import. Allowed only when status is drafting.
Authorizations
Parameters
Path Parameters
Request Body
Responses
Ticket import object
Preview ticket import
Process ticket import
TicketRules
Polymorphic ticket rules: sales rules, dated price changes, quantity price changes
Operations
Get ticket rules
Returns a list of ticket rules for an event
Authorizations
Parameters
Path Parameters
Event Id
"int64"Responses
Ticket rule list
Get ticket rule by type and ID
Returns a single ticket rule by type and id
Authorizations
Parameters
Path Parameters
Event Id
"int64"Rule type: sales-rule, dated-price-change, quantity-price-change
"sales-rule""dated-price-change""quantity-price-change"Rule Id
"int64"Responses
Ticket rule object
Delete ticket rule
Delete a ticket rule
Authorizations
Parameters
Path Parameters
Event Id
"int64"Rule type
"sales-rule""dated-price-change""quantity-price-change"Rule Id
"int64"Responses
Ticket rule deleted successfully
Update ticket rule
Update an existing ticket rule
Authorizations
Parameters
Path Parameters
Event Id
"int64"Rule type: sales-rule, dated-price-change, quantity-price-change
"sales-rule""dated-price-change""quantity-price-change"Rule Id
"int64"Request Body
Responses
Updated ticket rule
Create ticket rule
Create a ticket rule (sales-rule, dated-price-change, or quantity-price-change)
Authorizations
Parameters
Path Parameters
Event Id
"int64"Rule type: sales-rule, dated-price-change, quantity-price-change
"sales-rule""dated-price-change""quantity-price-change"Request Body
Responses
Created ticket rule
Bulk delete ticket rules
Delete multiple ticket rules
Authorizations
Parameters
Path Parameters
Event Id
"int64"Request Body
Responses
Ticket rules deleted successfully
Create a ticket type shipping method assignment
Assign a shipping method to a ticket type. Returns the existing record if the pair already exists.
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Responses
Created ticket type shipping method assignment
Bulk create ticket type shipping method assignments
Assign shipping methods to ticket types in bulk.
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Responses
Created ticket type shipping method assignments
Delete a ticket type shipping method
Deletes a ticket type shipping method assignment
Authorizations
Parameters
Path Parameters
Event ID
"int64"Ticket type ID
"int64"Shipping Method ID
"int64"Responses
Ticket type shipping method deleted successfully
Bulk delete ticket type shipping methods
Deletes multiple ticket type shipping method assignments.
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Responses
Ticket type shipping methods deleted successfully
Ticket Types
Endpoints to interact with ticket types
Operations
List ticket types
Returns a list of ticket types for an event
Authorizations
Parameters
Path Parameters
Event ID
"int64"Query Parameters
Filter by on sale status (0 or 1)
01Responses
Ticket type list
Create ticket type
Create a new ticket type for an event
Authorizations
Parameters
Path Parameters
Event ID
"int64"Request Body
Responses
Created ticket type
Get ticket type by ID
Returns a single ticket type by ID
Authorizations
Parameters
Path Parameters
Event ID
"int64"Ticket Type ID
"int64"Responses
Ticket type object
Delete ticket type
Update ticket type
Update an existing ticket type
Authorizations
Parameters
Path Parameters
Event ID
"int64"Ticket Type ID
"int64"Request Body
Responses
Updated ticket type
List ticket type tags
List ticket types
Returns a list of ticket types for an event
Authorizations
Parameters
Path Parameters
Event ID
"int64"Query Parameters
Filter by on sale status (0 or 1)
01Responses
Ticket type list
Get ticket type by ID
Returns a single ticket type by ID
Authorizations
Parameters
Path Parameters
Event ID
"int64"Ticket Type ID
"int64"Responses
Ticket type object
GET /api/v2/ticket-type/get-name
Get a list of unregistered customers
Authorizations
Parameters
Query Parameters
Include related resources (unpurchased). Note: unpurchasedCount is always included.
Responses
Unregistered customer list
Get an unregistered customer by ID
Authorizations
Parameters
Path Parameters
ID of unregistered customer to return
"int64"Query Parameters
Include related resources (unpurchased). Note: unpurchasedCount is always included.
Responses
Unregistered customer object
Delete an unregistered customer
Bulk delete unregistered customers
Send email to unregistered customers
Get preview of email count that will be sent
Get waivers
Returns a list of waivers
Authorizations
Parameters
Query Parameters
Filter by organizer ID
"int64"Filter by event ID
"int64"Responses
Waiver list
Create a new waiver
Get waiver by ID
Delete a waiver
Update a waiver
Delete multiple waivers
Get wave times
Returns a list of wave times for an event
Authorizations
Parameters
Path Parameters
Event Id
"int64"Responses
Wave time list
Create a new wave time
Get wave time by ID
Returns a single wave time
Authorizations
Parameters
Path Parameters
Event Id
"int64"Wave Time Id
"int64"Responses
Wave time object
Delete a wave time
Update a wave time
Update an existing wave time
Authorizations
Parameters
Path Parameters
Event Id
"int64"Wave Time Id
"int64"Request Body
Responses
Updated wave time object
List webhooks
Create webhook
Get webhook by ID
Delete webhook
Update webhook
Delete multiple webhooks
Find Webhook by Id
Delete one Webhook by Id
Update Webhook by Id
Find a list of Webhooks by a set of filters
Returns a list of Webhooks
Authorizations
Parameters
Query Parameters
Set the max number of objects to return
"int64"Set the number of objects to ignore before starting
"int64"text string that will search certain text fields
comma separated list of items to select ('tickets.*, ticketTypes.name')
type
display
objectType
Responses
Create Webhook
Run a Webhook of a specific type
Runs the enabled webhooks of a specific type on the referenceId
Authorizations
Parameters
Query Parameters
Webhook type (should be one of these): orderComplete, attendeeCheckinComplete, ticketClaimComplete, ticketCancelComplete, orderCancelComplete, informationChangeComplete, orderRefundComplete, orderInformationChangeComplete
should be the order Id for all types except attendeeCheckinComplete, ticketClaimComplete and ticketCancelComplete in which case it should be the ticketId
Responses
Get webhook types
Get wristband printing settings
Update wristband printing settings
Partial update. Accepts application/json or multipart/form-data. Image fields (logoImage, sponsorImage1–3) are upload-only and must be sent as multipart file parts.
Authorizations
Request Body
Responses
Settings updated successfully
List zaps
Create zap
Get zap by ID
Delete zap
Update zap
Delete multiple zaps
Auth0
Auth0 authentication endpoints for Admin2 UI
Operations
Get Auth0 authorization URL
Returns the Auth0 authorization URL for both TS and non-TS users. Only available when SITE_AUTH_METHOD=auth0 (returns 403 with error=ticketsocket_user_restricted otherwise).
Authorizations
Request Body
Responses
Auth0 authorization URL
Get Auth0 authorization URL for TicketSocket users
Deprecated. Use POST /auth/login instead. Returns the Auth0 authorization URL with a ticketsocket login channel flag in the state parameter. After Auth0 authentication, the callback will reject non-TicketSocket users (ticketSocketUser != 1), revoke their tokens, and redirect through Auth0 logout to clear the SSO session.
Authorizations
Request Body
Responses
Auth0 authorization URL with ticketsocket login channel
Auth0 callback handler
Handles the Auth0 callback, exchanges code for tokens, validates user in system_administrators, sets JWT cookie, and redirects. The deprecated ticketsocket login channel rejects non-TicketSocket users (?error_code=not_ticketsocket_user).
Authorizations
Parameters
Query Parameters
Authorization code from Auth0
State parameter containing redirect URI
Responses
Redirect to Admin2 UI after successful authentication
Get current user profile
Get current user profile (deprecation test)
Logout current user
Clears the authentication cookie and returns the Auth0 logout URL. The client should redirect the browser to logout_url to clear the Auth0 SSO session.
Authorizations
Parameters
Query Parameters
URL to redirect to after Auth0 logout completes
Responses
Logout successful. Auth cookie cleared. Client should redirect to logout_url.
Refresh authentication token
Legacy login (bypasses Auth0)
Authenticates user directly against the database using login and password, bypassing Auth0. Only available when SITE_AUTH_METHOD=legacy (returns 403 otherwise). Returns JWT token on success. TicketSocket users (ticketSocketUser=1) are rejected and must use the TicketSocket login channel instead.
Authorizations
Request Body
Responses
Login successful
Legacy logout (bypasses Auth0)
Clears the authentication cookie without redirecting to Auth0 logout URL. Returns JSON response instead of redirect.
Authorizations
Responses
Logout successful
Request password change via Auth0
Triggers a password reset email via Auth0. Only for users authenticated via Auth0.
Authorizations
Responses
Password reset email sent
Change password for legacy authenticated users
Changes password by verifying old password and setting new password. Only for users authenticated via legacy login.
Authorizations
Request Body
Responses
Password changed successfully
Request password reset email for legacy users
Generates a password reset token, stores it in the database, and sends a reset email to the user. Rate limited to 3 attempts per 24 hours. Response is intentionally vague to prevent email enumeration.
Authorizations
Request Body
Responses
Reset email sent (or account not found - same response to prevent enumeration)
Reset password using token from email
Validates the reset token and sets a new password. Token must be valid, not expired (24h), and not previously used. The token is tied to the specific administrator who requested the reset.
Authorizations
Request Body
Responses
Password reset successfully
Find BibAssignmentRule by Id
Delete one BibAssignmentRule by Id
Update BibAssignmentRule by Id
Find a list of BibAssignmentRules by a set of filters
Returns a list of BibAssignmentRules
Authorizations
Parameters
Query Parameters
Set the max number of objects to return
"int64"Set the number of objects to ignore before starting
"int64"text string that will search certain text fields
comma separated list of items to select ('tickets.*, ticketTypes.name')
name
bibStart
"int64"bibEnd
"int64"prefix
suffix
assignmentTime
chipAssignment
chipAssignmentFile
lastUpdated
"int64"archived
"int64"Responses
Create BibAssignmentRule
From a json order description, build the cart items list
Creates a line item for each ticket, question, insurance and fee (depending on settings)
Authorizations
Request Body
Responses
GET /api/v2/cart/build-cart-items-from-order-id
Process the cart data to describe what order would be created with it
Process the cart data to describe what order would be created with it
Authorizations
Request Body
Responses
Get ticket data for scanning purposes
Authorizations
Parameters
Query Parameters
Limit to tickets in this order
Limit to tickets for this event
Limit to tickets of this type
Limit to tickets for this customer
Limit to tickets matching this barcode
Limit to tickets matching this search string
Limit to tickets purchased after this date/time
Limit to tickets purchased before this date/time
Limit to tickets updated after this date/time
Limit to tickets updated before this date/time
Limit tickets to this number
"int64"Limit tickets to this number
"int64"Responses
Get custom dashboards
Get custom dashboards
Authorizations
Parameters
Query Parameters
Set the max number of custom dashboards to return.
"int64"Set the number of objects to ignore before starting.
"int64"Whether we'd like the custom dashboard permissions for user making request.
Responses
A list of custom dashboards user has access to.
Create a custom dashboard
Deletes an existing custom dashboard
Updates an existing custom dashboard
Returns the customer's user information
Deletes an existing customer.
Deletes an existing customer.
Authorizations
Parameters
Path Parameters
The id of the customer
Query Parameters
Determines the format of response. Default is id. Values:
- none
- id
- object
Responses
The customer was deleted. The format depends on the _response parameter.
Updates an existing customer.
Updates the existing customer.
Authorizations
Parameters
Path Parameters
The id of the customer
Query Parameters
Determines the format of response. Default is id. Values:
- none
- id
- object
Request Body
Responses
The customer was updated. The format depends on the _response parameter.
Retrieves a list of customers.
Returns a list of customer user's information.
Authorizations
Parameters
Query Parameters
Set the max number of customers to return.
"int64"Set the number of customers to ignore before starting.
"int64"Sets the order the customers can be returned. Can include one or more columns separated by a comma. Prefix + for ascending, - for descending. If not provided, sorted by id.
- id
- firstName
- lastName
- emailAddress
- username
Search by the customer's username.
Search by the customer's first name.
Search by the customer's last name.
Responses
A list of matching customers.
Create customer
Retrieve the list of email templates
Create an email template
Retrieve a specific email template
Send an Email
Create email template
GET /api/v2/export-profile/
Find Export Profile by ID
Get the columns of an export profile
Get the count of records for a set of filters
Generate a report using an export profile
FGL Template
Manages FGL templates and commands
Operations
Get FGL templates
Get FGL templates
Authorizations
Parameters
Query Parameters
Set the max number of fgl templates to return.
"integer"Set the number of objects to ignore before starting.
"integer"Responses
A list of fgl templates.
Create a fgl template
Get FGL signature for FGL print
Get FGL certificate
Deletes an existing fgl template
Updates an existing fgl template
Get FGL template commands
Get FGL template commands
Authorizations
Parameters
Path Parameters
The id of the fgl template
Query Parameters
Set the max number of fgl commands to return.
"integer"Set the number of objects to ignore before starting.
"integer"Responses
A list of fgl commands.
Get an FGL template command
Create a command for an fgl template
Create a command for an fgl template
Authorizations
Parameters
Path Parameters
The id of the fgl template
The id of the command
Request Body
Responses
Create command Succeeded
Deletes an existing fgl command
Updates an existing fgl command
Updates an existing fgl command
Authorizations
Parameters
Path Parameters
The id of the fgl template
The id of the fgl command
Request Body
Responses
Update command succeeded
Calculate the service fee for a given amount (front or backend)
Calculate the service fee for a given amount (front or backend)
Calculate the service fee for a given amount (front or backend)
Calculate the fee1 (usually tax) for a given ticketType and amount
Calculate the fee2 (usually gratuity) for a given ticketType and amount
Find Invites
Create a new Invite
Creates a new invite from the POST data
Authorizations
Request Body
Responses
Find Invite by Id
Localization
Endpoints to interact with localization
Operations
Finds a locationzation by name
Adds new phrases for a localization.
Adds new phrases for a localization. You can pass in a single phrase or an array of phrases.
Authorizations
Parameters
Path Parameters
Id of the localization
Request Body
Responses
The phrases where added.
Updates existing phrase for a localization.
Updates existing phrase for a localization. You can pass in a single phrase or an array of phrases.
Authorizations
Parameters
Path Parameters
Id of the localization
Request Body
Responses
The phrases where updates.
Finds a locationzation by name
Returns a single locationization and language.
Authorizations
Parameters
Path Parameters
Id of the localization language.
The start of name of phrase to search for.
Responses
The location was found.
Delete existing phrases for a localization.
Deletes existing phrases for a localization.
Authorizations
Parameters
Path Parameters
Id of the localization
The phrases to delete. You can include multiple seperated by a comma.
Responses
The updates was added.
Searches the list of localization.
Returns a list of localizations.
Authorizations
Parameters
Query Parameters
Set the max number of objects to return.
"int64"Set the number of objects to ignore before starting.
"int64"The phrase to include. Preforms a wild cart search.
Iso name of the language to return the localizations for.
Adds additional details to the results. Supports the following values:
- phrases - Include phrases for each localization.
- defaults - Include the list of default phrases.
Responses
Adds an existing location.
Finds a locationzation by id
Returns a single locationization
Authorizations
Parameters
Path Parameters
Id of the localization
Query Parameters
The phrase to include. Preforms a wild cart search.
Adds additional details to the results. Supports the following values:
- phrases - Include phrases for each localization.
- defaults - Include the list of default phrases.
Responses
The requested localization.
Deletes an existing location.
Authorizations
Parameters
Path Parameters
Id of the localization
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the customer is returend.
- object - The entire object is returned.
Responses
The location was found.
Updates an existing location.
Authorizations
Parameters
Path Parameters
Id of the localization language.
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the customer is returend.
- object - The entire object is returned.
Request Body
Responses
The location was found.
List of available phrase names
My Account
Endpoints for customer interaction with their account
Operations
Returns the customer's information.
Log in to the customer's account. Return's an auth token that can be used with remaining my account end points.
Create an account. Requires the caller be an admin that is part of the customer group.
Update account information.
Authorizations
Request Body
Responses
The account has been updated.
List of the events the customer has access to.
Authorizations
Parameters
Query Parameters
Search text in just the title - must match exactly unless you use a % to match any char
Search text in Title, Description, Venue, Venue Address - uses wildcard search
Returns events that start after the given date. The date is a unix timestamp.
falseReturns events that start before the given date. The date is a unix timestamp.
falseOnly return events the match the value. orders - Only return events that the user purchased a ticket for. all - Return all matching events.
"all"The maximum number of events to return.
The first event to return.
Responses
The list of events.
List of the ticket types for an event.
Authorizations
Parameters
Path Parameters
Id of event to return
"int64"Responses
The list of ticket types.
List of the wave times for an event.
GET /orders
Get orders
Authorizations
Parameters
Query Parameters
Include related and additional data. Accepted values: order_total, tickets, purchase_questions
"order_total,tickets,purchase_questions"Filter by order status. Accepted values: refunded, partial, checkedIn, purchased, unpaid
"purchased,checkedIn"Filter orders created from this datetime (format: Y-m-d H:i)
"2025-11-05 08:19"Filter orders created up to this datetime (format: Y-m-d H:i)
"2025-11-05 08:25"Filter by a single event ID
2Filter by multiple event IDs (comma-separated)
"1,2"Filter by ticket type ID
3Filter by minimum ticket price paid
100"float"Filter by maximum ticket price paid
200"float"Filter by payment methods (comma-separated). Accepted values: cash,credit,sezzle
"cash,credit"Filter by shipping method IDs (comma-separated)
"1,2"Filter by affiliate ID
286Filter by promo code ID
2Filter by promo code group name
"ICS Promo Code"Filter by admin user ID
1Filter by purchase source (comma-separated). Accepted values: boxOffice, frontEnd, backEnd, presale
"boxOffice,frontEnd"Filter by change status (comma-separated). Accepted value: transferred,eventChange,upgraded,claimed,unclaimed,withdrawn
"eventChange,upgraded"Filter by specific order ID
42962Filter by ticket barcode
"75387482648539"Filter by wave time IDs (comma-separated)
"1,2,3"Filter by last 4 digits of payment card
"4242"Filter by new customer flag (false = returning, true = new)
"false""true""false"Filter by ticket status. Accepted values: purchased, checkedIn, cancelled, refunded
"purchased,checkedIn"Filter orders purchased with a pass (true = yes)
"false""true""true"Include deleted orders (true = include deleted)
"false""true""true"Include all orders including deleted (true = yes)
"false""true""true"Responses
Order list
Returns the account's payment processor.
Returns the account's payment processor.
Sends an email to user.
Find order note by Id
Find a list of order notes by a set of filters
Returns a list of Orders
Authorizations
Parameters
Query Parameters
Set the max number of objects to return
"int64"Set the number of objects to ignore before starting
"int64"comma separated list of items to select ('tickets.*, ticketTypes.name')
Id of order to retreive the notes for
"int64"Responses
Create note for an order
Return auth code to connect Stripe's SDK
Return the list of terminals associted with the stripe account.
Authorizations
Responses
The current list of terminals.
Print Template
Manages Print templates and commands
Operations
Get Print Templates
Get Print Templates
Authorizations
Parameters
Query Parameters
Set the max number of print templates to return.
"integer"Set the number of objects to ignore before starting.
"integer"Responses
A list of print templates.
Create a print template
Get Print signature for Print print
Get Print certificate
Deletes an existing print template
Updates an existing print template
Get Print Template commands
Get Print Template commands
Authorizations
Parameters
Path Parameters
The id of the print template
Query Parameters
Set the max number of print commands to return.
"integer"Set the number of objects to ignore before starting.
"integer"Responses
A list of print commands.
Get an Print Template command
Create a command for an print template
Create a command for an print template
Authorizations
Parameters
Path Parameters
The id of the print template
The id of the command
Request Body
Responses
Create command Succeeded
Deletes an existing print command
Updates an existing print command
Updates an existing print command
Authorizations
Parameters
Path Parameters
The id of the print template
The id of the print command
Request Body
Responses
Update command succeeded
Render the Print Code from the template using the data from the ticketId specified
Render the Print Code from the template using the data from the ticketId specified
Authorizations
Parameters
Path Parameters
The id of the ticket to render with the template
Query Parameters
The id of the print template - optional - normal template lookup will occur otherwise (ticketType template, event template or site template)
Responses
A list of printer commands.
GET /api/v2/shared-inventory-group/
Shipping Method
Manage the list of shipping methods
Operations
GET /api/v2/shipping-method/
Returns the requested shipping method.
Deletes the requested shipping method.
Authorizations
Parameters
Path Parameters
The id of the shipping method.
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the shipping method is returend.
- object - The entire object is returned.
Responses
The shipping method that has been deleted. The format of the response depends on the type requested in the _repsonse parameter.
Updates an existing shipping method.
Authorizations
Parameters
Path Parameters
The id of the shipping method.
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the shipping method is returend.
- object - The entire object is returned.
Request Body
Responses
The shipping method was updated. The format of the response depends on the type requested in the _repsonse parameter.
Add a new shipping method.
Authorizations
Parameters
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the shipping method is returend.
- object - The entire object is returned.
Request Body
Responses
The shipping method was updated. The format of the response depends on the type requested in the _repsonse parameter.
Returns multiple shipping methods by id.
Authorizations
Request Body
Responses
The list of responses.
Adds multiple shipping methods.
Authorizations
Parameters
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the shipping method is returend.
- object - The entire object is returned.
Request Body
Responses
The list of responses.
Updates multiple shipping methods.
Authorizations
Parameters
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the shipping method is returend.
- object - The entire object is returned.
Request Body
Responses
The list of responses.
Deletes multiple shipping methods.
Authorizations
Parameters
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the shipping method is returend.
- object - The entire object is returned.
Request Body
Responses
The list of responses.
Shopping Cart
Manages shopping cart
Operations
Returns the settings for the shopping cart.
Returns the settings for the shopping cart.
Authorizations
Parameters
Query Parameters
If set then determin if the box office settings or non box office settings are returned. If not provided then all settings are returned.
Responses
The list of settings.
Adds tickets to the cart.
Creates a new shopping cart
Creates a new shopping cart.
Authorizations
Request Body
Responses
The new cart.
Update ticket
Update ticket by Id
Authorizations
Parameters
Path Parameters
Ticket Id
"int64"Request Body
Responses
Updated ticket object
Sets the price of a ticket.
Overrides the price of a ticket. Only support on box office, event change, and upgrade ticket carts.
Authorizations
Parameters
Path Parameters
ID of ticket to set the price for.
Request Body
Responses
The updated cart.
Sets the price of an addon.
Overrides the price of an addon. Only support on box office, event change, and upgrade ticket carts.
Authorizations
Parameters
Path Parameters
ID of ticket to set the price for.
ID of the addon to set the price for.
Request Body
Responses
The updated cart.
Returns the shipping methods available for the indicated tickets.
Returns the shippimg methods available for the ticket. If only one shipping method is available then the checkout call will automatically assign it if a shipping method hasn't been indiciated.
Authorizations
Parameters
Path Parameters
ID of ticket to get the shipping methods
Request Body
Responses
The cart with the answers.
Sets the shipping method for the ticket.
Sets the shipping method for the ticket. If only one shipping method is available then the checkout call will automatically assign it if a shipping method hasn't been indiciated.
Authorizations
Parameters
Path Parameters
ID of ticket to set the shipping method.
Request Body
Responses
The cart with the answers.
Removes the ticket from the cart.
Set the purchaser.
Sets purchaser for the cart. Replaces existing purchaser if there is one.
Authorizations
Request Body
Responses
The purchaser was set for the cart.
Set the attendee.
Sets attendee for the ticket. Replaces existing attendee if there is one.
Authorizations
Parameters
Path Parameters
ID of ticket to set
Request Body
Responses
The attendee was set.
Returns the questions for tickets
Get the list of questions for the tickets.
Authorizations
Parameters
Path Parameters
ID of ticket to get the questions for
Request Body
Responses
The list of question.
Sets the answer for a ticket
Sets the answer for a ticket. Replaces any existing answers.
Authorizations
Parameters
Path Parameters
ID of ticket to set the answers for
Request Body
Responses
The cart with the answers.
Set the billing info.
Sets billing info for the cart. Replaces existing billing if there is one.
Authorizations
Request Body
Responses
The billing information was set for the cart.
Returns the questions for tickets
Get the list of questions for the tickets.
Authorizations
Parameters
Path Parameters
ID of ticket to get the questions for
Request Body
Responses
The list of question.
Sets the answer for the order
Sets the price of an addon.
Overrides the price of an addon. Only support on box office, event change, and upgrade ticket carts.
Authorizations
Parameters
Path Parameters
ID of the addon to set the price for.
Request Body
Responses
The updated cart.
Returns the shipping methods available for all the tickets.
Returns the shippimg methods available for the cart. If only one shipping method is available then the checkout call will automatically assign it if a shipping method hasn't been indiciated.
Authorizations
Request Body
Responses
The list of shipping methods.
Update promo code
Applies shipping method to multiple tickets.
Applies shipping method to multiple tickets.
Authorizations
Parameters
Path Parameters
ID of ticket to remove
Request Body
Responses
The updated order.
Removes tickets from the cart.
Removes tickets from the cart.
Authorizations
Parameters
Path Parameters
ID of ticket to remove
Request Body
Responses
The updated order.
Cancels the cart.
Returns the cart's details.
Starts the checkout process.
Starts the checkout process returning information needed to process payment. This call can only be made once per order.
Authorizations
Parameters
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the customer is returend.
- object - The entire object is returned.
Request Body
Responses
The updated order.
Gather the current line items from cart
Calculate taxes based on describe order data
Find Tax Details by Transaction Id
Find an item's Tax Type
Find an item's Tax Type by itemId and itemType
Authorizations
Parameters
Query Parameters
Id of taxType - this is required unless an itemId and itemType are passed
"int64"Id of Item
"int64"Type of Item (ticketType, question, event)
Responses
Gets the list of Third Party Account.
Adds an additional third party account.
Authorizations
Parameters
Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the customer is returend.
- object - The entire object is returned.
Request Body
Responses
Gets the given Third Party Account.
Deleted a third party account.
Authorizations
Parameters
Path Parameters
Id of third party to delete.
"int64"Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the customer is returend.
- object - The entire object is returned.
Responses
Updates a third party account.
Authorizations
Parameters
Path Parameters
Id of third party to update.
"int64"Query Parameters
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
- none - no body is returned.
- id - The id of the customer is returend.
- object - The entire object is returned.
Request Body
Responses
POST /api/v2/upload
DELETE /api/v2/upload
Authorizations
Request Body
Responses
The file was succesfully uploaded.
POST /api/v2/upload/bulk
Authorizations
Request Body
Responses
The file was succesfully uploaded.
Get the currencies currently supported
Get the display name of a currency
Round an amount of a currency
Validate International Address
Accepts address parameters - line1, line2, city, region, country, postalCode
Authorizations
Request Body
Responses
Get wave times
Returns a list of wave times for an event
Authorizations
Parameters
Path Parameters
Event Id
"int64"Responses
Wave time list
Create a new wave time
Returns the given wave time.
Returns the given wave times for the given event.
Returns the given wave time for the given event.
Authorizations
Parameters
Path Parameters
Id of event to find wave times for
"int64"Query Parameters
Adds additional details to the results. Supports the following values: types - Include ticket type ids.
Responses
Returns the given wave times for the given ticket type.
Returns the given wave time for the given ticket type.
Authorizations
Parameters
Path Parameters
Id of ticket type to find wave times for
"int64"Query Parameters
Adds additional details to the results. Supports the following values: types - Include ticket type ids.
Responses
Delete a wave time
Update a wave time
Update an existing wave time
Authorizations
Parameters
Path Parameters
Event Id
"int64"Wave Time Id
"int64"Request Body
Responses
Updated wave time object