Update an existing access package
ID of the access package to update
"int64"Access package updated
Endpoints to interact with administrators
Adds additional details to the results. Supports the following values:
Information for the user who's signin in.
Update an existing administrator group
Administrator Group ID
"int64"Updated administrator group
Endpoints to manage attendee questions for events.
Returns a list of attendee question for an event
Event Id
"int64"Question ID
"int64"Ticket Type ID
"int64"Attendee Question list
Create a attendee question for an event
Event ID
"int64"Created attendee question
Delete a attendee question
Event ID
"int64"Attendee Question ID
"int64"Attendee question deleted successfully
Update ordering of attendee question
Event ID
"int64"Id of the attendee question to update
"int64"Updated attendee question
Create multiple attendee question for an event
Event ID
"int64"Ticket type ID
"int64"Created multiple attendee question
Deletes multiple attendee questions
Event ID
"int64"Attendee Questions deleted successfully
Partial update. Accepts application/json or multipart/form-data. topImage is upload-only in multipart requests and stored as public URL.
Settings updated successfully
Endpoints to interact with settings
Returns a list of Settings
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
Returns a list of bulk pricing rules for an event
Event Id
"int64"Bulk pricing rule list
Create bulk pricing rule
Event Id
"int64"Created bulk pricing rule object
Returns a single bulk pricing rule
Event Id
"int64"Bulk pricing rule Id
"int64"Bulk pricing rule object
Delete a bulk pricing rule
Event Id
"int64"Bulk pricing rule Id
"int64"Bulk pricing rule deleted successfully
Update an existing bulk pricing rule
Event Id
"int64"Bulk pricing rule Id
"int64"Updated bulk pricing rule object
Update an existing category
Category Id
"int64"Updated category object
Update an existing category group
Category Group Id
"int64"Updated category group object
Filter by ticket types. Expected comma-separated event ID(s).
Filter by ticket types. Expected comma-separated ticket type ID(s).
Flat list of scan overview rows (one per event and ticket type), including eventName
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.
Per-administrator rows with flat scanDetails (scan kind, ticket type id/name, unique tickets, total scans)
Endpoints to interact with connectJobs
Paginated jobs for the authenticated organizer scope. Optional eventId filters by event.
Connect job list
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.
Created
Updates schedule (startTime), disabled flag, and/or Connect email template. Unknown JSON keys are rejected (strict validation).
Updated job
Paginated recipient rows for the job; optional status filters by recipient status.
"completed""queued""failed"Paginated recipients (ConnectRecipientFormatter: status as lowercase string, orderId from objectId)
Dispatches the same admin connect runJob URL used by cron; returns immediately while sending continues in the background.
Run triggered; poll job/recipients for progress
Returns a list of ConnectJobs
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
Get a list of customers
100A list of customers
Downloads a CSV file containing customer details matching the given filters.
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)
CSV file download with customer details.
Updates the default localization ID and returns the localization object
Default localization updated, returns localization object
Endpoints to interact with events
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"Question list
Create event. Supports both JSON and multipart/form-data for file uploads.
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
Created event
Update event by Id. Supports both JSON and multipart/form-data for file uploads.
Events Id
"int64"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
Updated events object
Duplicate event by Id and return the new event. JSON body requires title, sefUrl, start, and end; optional cutOff, timezone, and processorId.
Source event ID to duplicate
"int64"Duplicate event
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.
Filters events based on if they've been published.
Filters events based on the select critera. If provided then onsale, published, and the date filters will be ignored.
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:
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.
Create event. Supports both JSON and multipart/form-data for file uploads.
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
Created event
Returns a list of ticketTypes
Event Id of the TicketTypes to return
"int64"Limit Results to this number
"int64"Limit Results to this number
"int64"Specific columns to select (else * will be selected)
Scans a ticket for an event.
The id of the event being scanned.
The ticket was successfully scanned.
Scans a ticket for a set of events.
The ticket was successfully scanned.
Returns all gallery images for an event, ordered by their ordering field
Event ID
"int64"Filter by published status
List of event images
Upload a new gallery image for an event. Supports both multipart/form-data and base64 JSON uploads.
Event ID
"int64"Image file to upload
"binary"Optional title for the image
Whether the image is published (default: true)
trueImage uploaded successfully
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.
Event ID
"int64"Images reordered successfully
Returns a list of shipping methods assigned to the given event, including event-specific settings such as shipping cutoff.
Event ID
"int64"Paginated list of event shipping methods
Update event-specific shipping method settings (e.g. shipping cutoff)
Event ID
"int64"Shipping Method ID
"int64"Updated event shipping method
Update event-specific shipping method settings (e.g. shipping cutoff) for multiple shipping methods.
Event ID
"int64"Updated event shipping methods
Endpoints to interact with FGL commands
Create a command for a specific FGL template
FGL Template ID
Created FGL command object
Get a single command by ID for a specific FGL template
FGL Template ID
FGL Command ID
FGL command object
Update a command for a specific FGL template
FGL Template ID
FGL Command ID
Updated FGL command object
Get a single FGL template
FGL Template ID
Include related resources
"commands"FGL template object
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.
Partial update of general settings. Accepts application/json or multipart/form-data with optional adminHeaderPicture file upload (jpeg, png, gif, webp, max 5MB).
Settings updated successfully
Incomplete order email settings (promo code, email content, schedule, event filter)
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.
Filter lists by name (partial match per ActiveCampaign API)
"newsletter"ActiveCampaign lists
Partial update; only present fields and phrase keys are updated
Localization ID
"int64"Localization updated
Creates a copy of the localization and all its phrases
Source localization ID to copy
"int64"Localization duplicated
Manages orders
Get orders
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"Order list
Get order by Id
Order Id
"int64"Include additional data. Accepted values: order_addons
"order_addons"Order object
Update order by Id
Orders Id
"int64"Updated orders object
Process a refund for an order. Use GET /orders/{id} to retrieve refundable item details.
Order Id
"int64"Refund processed successfully
Resend the order receipt via email. Optionally send to all attendees.
Order Id
"int64"Email receipt sent successfully
Downloads a CSV file containing order summaries matching the given filters.
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).
CSV file download with order summary rows.
Downloads a CSV file containing one row per ticket with attendee and cost details matching the given filters.
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.
CSV file download with one row per ticket.
Downloads a CSV file containing purchaser name, email, and order ID for each matching order.
CSV file download with purchaser rows.
Downloads a CSV file containing attendee name, email, and order ID for each ticket in matching orders.
CSV file download with one row per attendee.
Downloads a CSV file containing shipping address information for each ticket in matching orders.
Filter by shipping method ID.
CSV file download with shipping address rows.
Returns a single order
The id of the order
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.
The order was found.
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.
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:
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:
A list of matching orders.
Creates an order based on the cart created via the shopping cart end points. The order is only created after payment has been verified.
The order was created after payment was successfully. The order is only included if result is order.
Scans all tickets in an order.
The id of the order.
The order was successfully scanned.
Orders settings (incomplete order email, upgrade ticket, change order, ticket transfer, send to a friend)
Return only the specified sub-setting object
"incompleteOrder""upgradeTicket""changeOrder""ticketTransfer""sendToFriend"Orders settings
Endpoints to manage payment processor settings
Endpoints to interact with promo codes
Filter by status
"active""inactive""soldOut""expired""active"Filter by type
"specific""percentage""flat""specificTag""percentage"Promo code list
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.
CSV or TXT file
"binary"Treat first row as column headers
falseMax preview rows (1–100)
20Upload result
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.
Session id returned by POST /api/v2/promo-codes/import/upload
"uuid"Import result
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.
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"Export created; use downloadUrlPath with site origin or email link
Filter by status
"active""inactive""soldOut""expired""active"Filter by type
"specific""percentage""flat""specificTag""percentage"Promo code list
ID of promo code to use
"int64"Ticket type to apply discount to
"int64"Original price
"float"Already applied amount
"int64"Uses v2-only PublicSettingSite::getPublicSettings() - same logic as v1:
latest system_settings (order by timestamp desc limit 1), then customFields
where settingsId = that id.
Public setting object
Purchaser question sales report endpoints for summary, charts, and question breakdown
Returns a list of questions
Filter questions by types
Filter questions by group ID
1Question list
Returns a single question
Question Id
"int64"To include localized question and answer. Example: ?localizations=en,fr, ?localizations=* for all available localizations
Question object with relation answers, group, and tags
Update an existing question group
Group Id
"int64"Updated question group object
Update an existing shipping method
ID of the shipping method to update
"int64"Shipping method updated
Filter by status
"active""inactive""soldOut""expired""active"Filter by expired codes (true/1 for expired, false/0 for active)
"true"Stored value code list
Update stored value code by id in request body
Stored value code ID
"int64"Stored value code updated
Filter by status
"active""inactive""soldOut""expired""active"Filter by expired codes (true/1 for expired, false/0 for active)
"true"Stored value code list
List teams with optional search, sort, and includes
Filter by event ID
Comma-separated: tickets, event
"tickets,event"Paginated team list
Unassigns tickets from the team (sets teamId to 0). If the team captain is removed, captain is cleared.
Tickets unassigned
Returns a list of Teams
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
Endpoints to manage and export 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.
Field list
Endpoints to interact with tickets
Returns a list of tickets
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"Ticket list
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.
Comma-separated event IDs (required)
"1,2,3"Sold and checked-in counts for the requested events
Ticket Id
"int64"Comma-separated optional expansions: change_status, ticket_status, purchaser, checkInInfo (same as GET /tickets)
"purchaser,checkInInfo"Ticket object
Update ticket by Id
Ticket Id
"int64"Updated ticket object
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.
Ticket Id
"int64"Ticket checked in; returns the ticket resource (same as GET /tickets/{id})
Upload attendee profile photo (multipart). Stored as public URL on the ticket.
Ticket Id
"int64""binary"Ticket with profilePhoto set
Remove stored profile photo URL from the ticket (best-effort delete of public object).
Ticket Id
"int64"Ticket with profilePhoto cleared
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:
Returns whether the provided bib is available for the given ticket.
Ticket ID
"int64"Bib number to check
"int64"Bib availability result
Returns a list of ticket groups
Event Id
"int64"Ticket group list
Returns a single ticket group
Event Id
"int64"Ticket Group Id
"int64"Ticket group object
Deletes a ticket group
Event Id
"int64"ID of the ticket group to delete
"int64"Ticket group deleted successfully
Update an existing ticket group
Event Id
"int64"ID of the ticket group to update
"int64"Updated ticket group object
CSV ticket import: upload file, map columns, preview, and run import (update existing or create new tickets).
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.
Ticket import and/or file deleted successfully
Save column mapping for the import. Allowed only when status is drafting.
Ticket import object
Polymorphic ticket rules: sales rules, dated price changes, quantity price changes
Returns a list of ticket rules for an event
Event Id
"int64"Ticket rule list
Returns a single ticket rule by type and id
Event Id
"int64"Rule type: sales-rule, dated-price-change, quantity-price-change
"sales-rule""dated-price-change""quantity-price-change"Rule Id
"int64"Ticket rule object
Delete a ticket rule
Event Id
"int64"Rule type
"sales-rule""dated-price-change""quantity-price-change"Rule Id
"int64"Ticket rule deleted successfully
Update an existing ticket rule
Event Id
"int64"Rule type: sales-rule, dated-price-change, quantity-price-change
"sales-rule""dated-price-change""quantity-price-change"Rule Id
"int64"Updated ticket rule
Create a ticket rule (sales-rule, dated-price-change, or quantity-price-change)
Event Id
"int64"Rule type: sales-rule, dated-price-change, quantity-price-change
"sales-rule""dated-price-change""quantity-price-change"Created ticket rule
Delete multiple ticket rules
Event Id
"int64"Ticket rules deleted successfully
Assign a shipping method to a ticket type. Returns the existing record if the pair already exists.
Event ID
"int64"Created ticket type shipping method assignment
Assign shipping methods to ticket types in bulk.
Event ID
"int64"Created ticket type shipping method assignments
Deletes a ticket type shipping method assignment
Event ID
"int64"Ticket type ID
"int64"Shipping Method ID
"int64"Ticket type shipping method deleted successfully
Deletes multiple ticket type shipping method assignments.
Event ID
"int64"Ticket type shipping methods deleted successfully
Endpoints to interact with ticket types
Returns a list of ticket types for an event
Event ID
"int64"Filter by on sale status (0 or 1)
01Ticket type list
Create a new ticket type for an event
Event ID
"int64"Created ticket type
Returns a single ticket type by ID
Event ID
"int64"Ticket Type ID
"int64"Ticket type object
Update an existing ticket type
Event ID
"int64"Ticket Type ID
"int64"Updated ticket type
Returns a list of ticket types for an event
Event ID
"int64"Filter by on sale status (0 or 1)
01Ticket type list
Returns a single ticket type by ID
Event ID
"int64"Ticket Type ID
"int64"Ticket type object
Include related resources (unpurchased). Note: unpurchasedCount is always included.
Unregistered customer list
ID of unregistered customer to return
"int64"Include related resources (unpurchased). Note: unpurchasedCount is always included.
Unregistered customer object
Returns a list of waivers
Filter by organizer ID
"int64"Filter by event ID
"int64"Waiver list
Returns a list of wave times for an event
Event Id
"int64"Wave time list
Returns a single wave time
Event Id
"int64"Wave Time Id
"int64"Wave time object
Update an existing wave time
Event Id
"int64"Wave Time Id
"int64"Updated wave time object
Returns a list of Webhooks
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
Runs the enabled webhooks of a specific type on the referenceId
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
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.
Settings updated successfully
Auth0 authentication endpoints for Admin2 UI
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).
Auth0 authorization URL
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.
Auth0 authorization URL with ticketsocket login channel
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).
Authorization code from Auth0
State parameter containing redirect URI
Redirect to Admin2 UI after successful authentication
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.
URL to redirect to after Auth0 logout completes
Logout successful. Auth cookie cleared. Client should redirect to logout_url.
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.
Login successful
Clears the authentication cookie without redirecting to Auth0 logout URL. Returns JSON response instead of redirect.
Logout successful
Triggers a password reset email via Auth0. Only for users authenticated via Auth0.
Password reset email sent
Changes password by verifying old password and setting new password. Only for users authenticated via legacy login.
Password changed successfully
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.
Reset email sent (or account not found - same response to prevent enumeration)
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.
Password reset successfully
Returns a list of BibAssignmentRules
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"Creates a line item for each ticket, question, insurance and fee (depending on settings)
Process the cart data to describe what order would be created with it
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"Get custom dashboards
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.
A list of custom dashboards user has access to.
Deletes an existing customer.
The id of the customer
Determines the format of response. Default is id. Values:
The customer was deleted. The format depends on the _response parameter.
Updates the existing customer.
The id of the customer
Determines the format of response. Default is id. Values:
The customer was updated. The format depends on the _response parameter.
Returns a list of customer user's information.
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.
Search by the customer's username.
Search by the customer's first name.
Search by the customer's last name.
A list of matching customers.
Manages FGL templates and commands
Get FGL templates
Set the max number of fgl templates to return.
"integer"Set the number of objects to ignore before starting.
"integer"A list of fgl templates.
Get FGL template commands
The id of the fgl template
Set the max number of fgl commands to return.
"integer"Set the number of objects to ignore before starting.
"integer"A list of fgl commands.
Create a command for an fgl template
The id of the fgl template
The id of the command
Create command Succeeded
Updates an existing fgl command
The id of the fgl template
The id of the fgl command
Update command succeeded
Creates a new invite from the POST data
Endpoints to interact with localization
Adds new phrases for a localization. You can pass in a single phrase or an array of phrases.
Id of the localization
The phrases where added.
Updates existing phrase for a localization. You can pass in a single phrase or an array of phrases.
Id of the localization
The phrases where updates.
Returns a single locationization and language.
Id of the localization language.
The start of name of phrase to search for.
The location was found.
Deletes existing phrases for a localization.
Id of the localization
The phrases to delete. You can include multiple seperated by a comma.
The updates was added.
Returns a list of localizations.
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:
Returns a single locationization
Id of the localization
The phrase to include. Preforms a wild cart search.
Adds additional details to the results. Supports the following values:
The requested localization.
Id of the localization
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The location was found.
Id of the localization language.
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The location was found.
Endpoints for customer interaction with their account
The account has been updated.
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.
The list of events.
Id of event to return
"int64"The list of ticket types.
Get orders
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"Order list
Returns a list of Orders
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"The current list of terminals.
Manages Print templates and commands
Get Print Templates
Set the max number of print templates to return.
"integer"Set the number of objects to ignore before starting.
"integer"A list of print templates.
Get Print Template commands
The id of the print template
Set the max number of print commands to return.
"integer"Set the number of objects to ignore before starting.
"integer"A list of print commands.
Create a command for an print template
The id of the print template
The id of the command
Create command Succeeded
Updates an existing print command
The id of the print template
The id of the print command
Update command succeeded
Render the Print Code from the template using the data from the ticketId specified
The id of the ticket to render with the template
The id of the print template - optional - normal template lookup will occur otherwise (ticketType template, event template or site template)
A list of printer commands.
Manage the list of shipping methods
The id of the shipping method.
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The shipping method that has been deleted. The format of the response depends on the type requested in the _repsonse parameter.
The id of the shipping method.
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The shipping method was updated. The format of the response depends on the type requested in the _repsonse parameter.
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The shipping method was updated. The format of the response depends on the type requested in the _repsonse parameter.
The list of responses.
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The list of responses.
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The list of responses.
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The list of responses.
Manages shopping cart
Returns the settings for the shopping cart.
If set then determin if the box office settings or non box office settings are returned. If not provided then all settings are returned.
The list of settings.
Creates a new shopping cart.
The new cart.
Update ticket by Id
Ticket Id
"int64"Updated ticket object
Overrides the price of a ticket. Only support on box office, event change, and upgrade ticket carts.
ID of ticket to set the price for.
The updated cart.
Overrides the price of an addon. Only support on box office, event change, and upgrade ticket carts.
ID of ticket to set the price for.
ID of the addon to set the price for.
The updated cart.
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.
ID of ticket to get the shipping methods
The cart with the answers.
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.
ID of ticket to set the shipping method.
The cart with the answers.
Sets purchaser for the cart. Replaces existing purchaser if there is one.
The purchaser was set for the cart.
Sets attendee for the ticket. Replaces existing attendee if there is one.
ID of ticket to set
The attendee was set.
Get the list of questions for the tickets.
ID of ticket to get the questions for
The list of question.
Sets the answer for a ticket. Replaces any existing answers.
ID of ticket to set the answers for
The cart with the answers.
Sets billing info for the cart. Replaces existing billing if there is one.
The billing information was set for the cart.
Get the list of questions for the tickets.
ID of ticket to get the questions for
The list of question.
Overrides the price of an addon. Only support on box office, event change, and upgrade ticket carts.
ID of the addon to set the price for.
The updated cart.
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.
The list of shipping methods.
Applies shipping method to multiple tickets.
ID of ticket to remove
The updated order.
Removes tickets from the cart.
ID of ticket to remove
The updated order.
Starts the checkout process returning information needed to process payment. This call can only be made once per order.
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The updated order.
Find an item's Tax Type by itemId and itemType
Id of taxType - this is required unless an itemId and itemType are passed
"int64"Id of Item
"int64"Type of Item (ticketType, question, event)
Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
Id of third party to delete.
"int64"Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
Id of third party to update.
"int64"Determines the format of repsonse. If not provided the default is id. Can be one of the following values:
The file was succesfully uploaded.
The file was succesfully uploaded.
Accepts address parameters - line1, line2, city, region, country, postalCode
Returns a list of wave times for an event
Event Id
"int64"Wave time list
Returns the given wave time for the given event.
Id of event to find wave times for
"int64"Adds additional details to the results. Supports the following values: types - Include ticket type ids.
Returns the given wave time for the given ticket type.
Id of ticket type to find wave times for
"int64"Adds additional details to the results. Supports the following values: types - Include ticket type ids.
Update an existing wave time
Event Id
"int64"Wave Time Id
"int64"Updated wave time object