Jump to Content
Guides
Discussions
Home
Guides
API Reference
Changelog
Discussions
v1.0
Guides
Discussions
API Reference
v1.0
API Reference
Adds a Square E-Commerce Processor to the system.
JUMP TO
Authorisation Header
Auth header test
get
Widgets
/widgets
post
Table of contents
Page 1
Page 2
Page 3
Required path params
Test removing required label
get
Swagger Petstore
pet
Add a new pet to the store
post
Update an existing pet
put
Finds Pets by status
get
Finds Pets by tags
get
Find pet by ID
get
Updates a pet in the store with form data
post
Deletes a pet
del
uploads an image
post
store
Returns pet inventories by status
get
Place an order for a pet
post
Find purchase order by ID
get
Delete purchase order by ID
del
user
Create user
post
Creates list of users with given input array
post
Creates list of users with given input array
post
Logs user into the system
get
Logs out current logged in user session
get
Get user by user name
get
Updated user
put
Delete user
del
Basic Auth
Basic auth no password
get
Yian's 404 API
200
get
404
get
Test manual
Test
get
Test manual
Post
post
Redirect API
Redirect test
get
readme.io updated 2
/
get
get
Swagger
/swagger
post
/swagger/{id}
put
/swagger/{id}
del
Test image in html block
Test image in html block
get
TicketSocket.Api
AccountsV1
Returns the user name and the identity of the login provider for the current user.
get
/api/accounts/logout
post
Creates a Password reset code for the user with the provided Email Address and sends an Email to the User
post
Updates a logged in user's password.
post
Resets the User's password by verifying the Email Address and random code. and accepting the new password.
post
Resets the Super Admin's password. and accepting the new password.
post
Changes user password.
post
/api/accounts/set-password
post
Registers a Super Admin within the System.
post
Registers a Sales Rep into the system.
post
Registers a Customer in the system.
post
AffiliatesV1
Activates affiliate tracking code.
put
Lists the affiliates for a given site.
get
Adds an affiliate to the parent company of the Site where the Affiliate is added. Affiliates are always added at the parent company level so that they can be shared among sites.
post
Gets the affiliate by its Id.
get
Updates an affiliate to the parent company of the Site where the Affiliate is added. Affiliates are always added at the parent company level so that they can be shared among sites.
put
Clones a affiliate by copying Name, Parent Affiliate and Tracking Codes if exist.
post
Lists the codes for a given affiliate.
get
Adds an affiliate Tracking code to the model.
post
Gets the Affiliate code by Id.
get
Updates an affiliate Tracking code to the model.
put
Adds priced event assignments for a given Affiliate Code.
post
Archives affiliate tracking code.
put
Archives an Affiliate assigned to a given Site. This doesn't archive the Affiliate itself. It only archives the relationship of the Affiliate to the site.
put
Assigns an existing Affiliate to the Site.
post
Blacklists an event from the Affiliate Code.
post
Deactivates affiliate tracking code.
put
Updates the existing Blacklisted Event's criteria.
put
Removes a blacklisted event from the list.
del
Updates the Exclusive Event Assignment by the Event Id.
put
Removes an Event Assignment from an Affiliate code.
del
Restores affiliate tracking code.
put
Restores a previously archived Site Affiliate assignment.
put
Adds tiered commissions for a given code.
post
Lists an Affiliate's Admins.
get
Adds an Affiliate Admin if one isn't already added. Administrators should be globally unique within the system.
post
Activates a previously deactivated Affiliate Admin.
put
Deactivates an Affiliate Admin.
put
Archives an Affiliate Admin.
put
Restores a previously archived Affiliate Admin.
put
Gets Affiliates Statistics.
get
Gets Statistics for an Affiliate.
get
Gets Affiliates Graph.
get
Gets Graph for an Affiliate.
get
Gets Affiliates Orders.
get
Gets Orders for an Affiliate.
get
Gets Affiliates Report.
get
Gets Report for an Affiliate.
get
ApiClientsV1
Adds an API Key for a given User.
post
Adds a new api client.
post
BillingRulesV1
Gets the Company's Ticket Billing Rules.
get
Adds the Company level Ticket Billing Rules.
post
Updates the Ticket Billing Rule.
put
Archives the Ticket Billing Rule
del
Restores the Ticket Billing Rule
put
Gets the Site's Ticket Billing Rules. If the Site doesn't directly have billing rules associated with it, then gets the parent Company's rules.
get
Adds a site billing rule.
post
BillingServiceV1
Gets the Orders to bill.
get
Gets the Billing Summary for a given Site based on the from/to date ranges.
get
Gets the Billing Report for a given site.
get
Generates a billing report for the Site for the given Date range.
post
BoxOfficeV1
Gets the Box Office Settings for a Logged In User.
get
BulkDiscountsV1
Gets list of Single Event Bulk Discount Rules.
get
Adds Single Event Bulk Discount Rule.
post
Gets Single Event Bulk Discount Rule.
get
Updates Single Event Bulk Discount Rule.
put
Deletes Single Event Bulk Discount Rule.
del
Activates Single Event Bulk Discount Rule.
put
Deactivates Single Event Bulk Discount Rule.
put
Archives Single Event Bulk Discount Rule.
put
Restores Single Event Bulk Discount Rule.
put
Adds/Updates Quantity Qualifier for a Single Event Bulk Discount Rule.
post
Deletes Quantity Qualifier for a Single Event Bulk Discount Rule.
del
Adds/Updates Tier Qualifier for a Single Event Bulk Discount Rule.
post
Deletes Tier Qualifier for a Single Event Bulk Discount Rule.
del
Adds/Updates Quantity Discount for a Single Event Bulk Discount Rule.
post
Deletes Quantity Discount for a Single Event Bulk Discount Rule.
del
Adds/Updates Tier Discount for a Single Event Bulk Discount Rule.
post
Deletes Tier Discount for a Single Event Bulk Discount Rule.
del
CompaniesV1
Gets a flattened list of Domains that belong to the company.
get
Allows Administrators of the System to list the Companies within the system.
get
Allows an administrator to Add a Company.
post
Gets the Company by Id.
get
Updates the Company information.
put
Gets a list of Company administrators.
get
Allows Administrators to add a Company Administrator. A company administrator can manage all companies under the current company's hierarchy.
post
Gets company admin by userId.
get
/api/companies/{companyId}/archive
put
/api/companies/{companyId}/restore
put
List child companies for a given parent Company.
get
Adds a Child Company under a given company.
post
Getting the list of company addresses.
get
Adds an Address of a given Company.
post
Gets the Company Address by Id.
get
Updates the Company Address.
put
Lists the Company's Users
get
Archives a Company User.
put
Restores a user.
put
/api/companies/users/{userId}/info
put
Allows an administrator or super admin to change password of its members.
post
Changes a Company's Parent.
put
Gets the Company Plugs by Site Id.
get
Installs plug for the given Company Id.
post
Activates the Plug for the Company Id.
put
Deactivates the Plug for the Company Id.
put
Gets company logo information.
get
Uploads a logo for a company.
post
Deletes company logo.
del
Gets the Company Contacts.
get
Adds a Company Contact.
post
Gets a Company Contact by Id.
get
Updates a Company Contact.
put
Deletes the Company Contact by a Contact Id.
del
Activates a company Contact.
put
Deactivates a Company Contact.
put
Archives a Company Contact.
put
Restores a previously archived Company Contact.
put
CustomFieldGroupsV1
Gets Custom Field Groups by Field Usage.
get
Adds Custom Field Group.
post
Updates Custom Field Group.
put
Adds Field Assignment.
post
Updates Field Assignment.
put
Reorders the Custom Field Groups in the Order provided.
put
Reorders the Custom Field assignments in the Order provided.
put
Gets Custom Field Group based on the Field Group Id.
get
Gets Custom Field Groups.
get
Gets field assignments based on Custom Field Group Id.
get
Removes field assignment from the Custom Field Group.
del
Archives Custom Field Group.
put
Restores Custom Field Group.
put
Verifies if the slug is already in use or not.
get
DomainsV1
Searches the Domain information by Domain name.
get
Validates the Domain name and checks for unqiueness.
post
Gets the plugs by domain.
get
Gets the logo by domain.
get
Gets the root company for the domain name.
get
EventBookingsV1
Gets the booking calendar for the GTO for a given Date Range.
get
Gets the Booking Summary Report.
get
Gets the Event's Time slot bookings/orders.
get
Gets the Ticket Types for all the Time slots in the given day.
get
Gets the mapped Ticket Types (and corresponding tiers) for a Time Slot.
get
Gets the Occurrence Inventory.
get
NEW METHOD - Brings back the Time Slot's ticket type mappings with the time slot info and the inventory.
get
Checks if the inventory is available for a given time slot for a given Event.
get
Checks the transfer availability and returns the occurrences with the availability.
post
EventBundlingV1
Adds the Tier bundling criteria.
post
EventFeesV1
Gets the Event's Fees.
get
Adds a service fee for a given event.
post
Clones fees from an existing Event.
post
Gets the Event Fee by Id.
get
Update Fee by Id.
put
Adds Fee Ticket Type Assignments.
post
Archives the Event Fee.
put
Restores a previously archived Event Fee.
put
Updates the Fee Ticket Type Assignments.
post
EventOptionsV1
Clones an Event and its Ticket Types.
post
EventPackagesV1
Lists candidate events to add to a Package Event.
get
Gets event packages for a given site.
get
Adds an event package.
post
Gets Packaged Sub Events.
get
Adds sub events to event package
post
Gets Packaged Sub Event.
get
Updates sub event.
put
Deletes Packaged Sub Event.
del
Sets Main Attraction as true/false.
put
Gets Package Tier Assignments.
get
Adds Package Tier Assignments along with optional Advanced Options.
post
Gets Single Package Tier Assignment.
get
Updates Package Tier Assignments along with optional Advanced Options.
put
Deletes Single Package Tier Assignment.
del
Gets Package Section Assignments.
get
Adds Package Section Assignments.
post
Gets Package Section Assignment with Seat Information.
get
Updates Package Section Assignment.
put
Deletes Single Package Section Assignment.
del
Adds Package Row Assignments.
post
Adds seats to Row Assignment.
post
Deletes Single Package Row Assignment.
del
Deletes Single Seat from Row Assignment.
del
EventPreSalesV1
Gets the PreSales for an event.
get
Assign preSales to an event
post
Gets an Event Pre Sale by Id
get
Updates an existing PreSale
put
Activate an event preSale
put
Deactivate an event preSale
put
Archive an event preSale
put
Restore an archived event preSale
put
EventProductAssignmentsV1
Gets a list of products assigned to an Event.
get
Adds Event products.
post
Archives a Product from a given ticket tier for a given event.
put
Archives a Product from all Tiers for a given event.
put
Restores a Product for a given ticket tier for a given event.
put
Restores a Product for all Tiers for a given event.
put
Deactivates a Product from a given ticket tier for a given event.
put
Deactivates a Product from all Tiers for a given event.
put
Activates a Product for a given ticket tier for a given event.
put
Restores a Product for all Tiers for a given event.
put
EventQuestionsV1
Gets the Attendee Questions assigned for the Event and its Tiers.
get
Gets the Purchaser Questions assigned for the Event and its Tiers.
get
Removes the Attendee Question Group assignment from a tier.
post
Removes the Purchaser Question Group assignment from a tier.
post
Adds or Updates Tier Level Event Question assignments for the Purchaser.
post
Adds or Updates Tier Level Event Question assignments for the Purchaser.
post
EventRecurrencesV1
Gets Event Time Slots.
get
Adds an Event Time Slot.
post
Updates the Event Time slot.
put
Archives a Time Slot.
put
Restores a Time Slot.
put
Gets the Event's Exception Dates.
get
Adds one or more Event Exception Date/Times.
post
Removes one or more Event Exception Date/Times.
del
Gets Sample Occurrences for a given Recurrence Pattern.
post
Gets the Event Occurrences for a given date range. The from/to date ranges will always be capped of by the Recurrence Pattern from/to date ranges, or the Event's From/To Dates if present.
get
Gets a Recurrence Pattern by Id.
get
Adds Additional Occurrences.
post
Removes additional Occurrence dates from a given Recurrence Pattern.
del
Gets the Pattern's additional occurrences by Date.
get
Adds one or more Ticket Type Assignments to a Pattern.
post
Gets the Ticket Type assignments for a given pattern by time slot.
get
Gets Event Recurrence Patterns. If 'includeArchived' is set to 'true', will return archived patterns as well.
get
Adds a yearly recurrence Pattern to an Event.
post
Updates the yearly recurrence pattern for the Event.
put
Adds a monthly recurrence Pattern to an Event.
post
Updates the monthly recurrence pattern for the Event.
put
Adds a Weekly recurrence Pattern to an Event.
post
Updates the weekly recurrence pattern for the Event.
put
Archives the Recurrence Pattern.
put
Restores the Recurrence Pattern.
put
EventRegistrantsV1
Gets the Event Registrants. If skipPaging is set to true, will get all records (primarily used for Exporting data in Excel format). Pass http accept header values as "Accept : application/vnd.ms-excel" to obtain an Excel export. Or alternatively, pass format query string parameter with a value "excel".
get
EventSeatingV1
Activates the reserved hold.
put
Gets the Reserved Holds.
get
Adds a Reserved Hold for one or more Sections.
post
Gets the Ticket Type Section Assignments.
get
Adds the Ticket Type Section Assignments.
patch
Gets the Tier Section Assignments.
get
Adds Section Assignments for a given tier.
patch
Archives reserved hold code.
put
Gets the Blocked seats for a given Event.
get
Blocks section's rows or seats.
post
Deletes a given hold.
post
Gets a Reserved Hold by Id
get
Updates the Reserved Hold
put
Gets the Sales Matrix for a given section.
get
Gets the Tiers assigned to the GA/Standing section.
get
Migrates the existing Seating Assignments to the new format.
post
Restores a reserved hold code.
put
Deactivates a reserved hold code.
put
Gets the Venue stats for the given Event (and its occurrence if this is a recurring event).
get
Gets the venue stats for the given Event (and its occurrence if this is a recurring event).
get
Gets the seating stats for the given Event (and its occurrence if this is a recurring event).
get
Gets the Pricing Setup for all sections for a given Venue for an event. If one or more sections aren't assigned, an incomplete status will be shown.
get
Assigns Section Pricing for a given Event.
post
Gets a single Section's Event Pricing.
get
Deletes the Section's Pricing for a given Event.
del
Gets the Section Reservations for a given Event.
get
EventsMediaV1
Gets a List of PhotoInfo items for an Event.
get
Uploads image for an Event.
post
Gets a List photo for the Event.
get
Upload image for ListPhoto of Event
post
Deletes a list photo for the Event.
del
/api/sites/{siteId}/events/{eventId}/photos/{photoId}
get
Deletes a photo ojbect for an Event.
del
Gets a list of Embedded Video's assigned to an Event.
get
Adds Embedded Video for an Event.
post
Get Embedded Video assigned to an Event by Video Id.
get
Update Embedded video for an Event.
put
Deletes embedded video from an Event.
del
EventsV1
Sets the Event Order.
post
Gets events for a given site.
get
Adds an event
post
Gets previously Archived Events for a site.
get
Gets the events that has passed the current date.
get
Gets list of upcoming Events occuring after current date.
get
Get the Event Description for the given event id.
get
Updates the Event Descriptions.
put
Adds the Event Description information like Long, Short descriptions and tags.
post
Gets an Event by the Event Id.
get
Updates an event.
put
Updates the Event Currency Settings.
put
Adds or updates the Event's categories.
post
Gets the Event's Tiers.
get
Gets the Children Events for the specified Parent.
get
Publishes the Event and makes it active for purchasing tickets.
put
Un-publishes/de-activates an event so customers cannot purchase tickets.
put
Sets an Event on sale.
put
Sets an Event as a Featured Event.
put
Resets an Event as a Featured Event.
del
Sets an Event as not on sale.
put
Hides an Event.
put
Shows an Event.
put
Gets the publishing options for the specified event Id.
get
Archives a given Event.
put
Restores a previously archived event.
put
Gets payment processor assigned to event
get
Assign payment processor to an event
post
Removes payment processor assigned to an event.
del
Verifies the Slug for uniqueness. A site cannot have events with duplicate URL slugs.
post
Updates an Event's Slug.
post
Gets Receipt setting details of the given eventId.
get
Saves the Receipt Settings.
post
Updates the Event's Receipt Settings.
put
Get Ticket Shipping Option for EventId
get
Adds Ticket Shipping Option to Event.
post
Updates Ticket Shipping options for the specified TicketShippingOptionTypeId
put
Deletes TicketShippingOption for the given OptionTypeId
del
Gets the GA Event's Inventory. Will return an error if the Event is a Recurring Event.
get
FccV1
Cancels an earlier request using the Merchant Reference Code associated with the original request.
post
Parses the response from FCC and finalizes the Order if Payment was successful, or returns back the error message accordingly.
post
FglTemplatesV1
Lists the Site's FGL Templates.
get
Adds the FGL Template to the Database.
post
Gets the FGL template by id.
get
Updates the FGL Template.
put
Archives FGL template.
put
Restores FGL template.
put
Clones FGL template. Creates duplicate of current FGL template.
post
Gets the Event's FGL Template Settings
get
Saves the Event's FGL Template model.
post
Lists FGL commands for a template.
get
Creates FGL template command.
post
Deletes all FGL commands
del
Gets a single FGL command.
get
Updates FGL template command.
put
Deletes FGL template command.
del
Sorts commands in a Sequence.
post
FieldsV1
Gets a Field based on the Field Id.
get
Gets a list of fields for the associated Usage Type.
get
Saves a Select Custom Field. Select Custom Field can be of Type Single/Multi based on the properties set in the object.
post
Adds free text custom field.
post
Adds toggle field custom field.
post
Adds Address field
post
Updates a AddressField.
put
Updates Select Field.
put
Updates a Toggle field.
put
Updates the Text Field.
put
Adds answer option.
post
Updates answer option.
put
Deletes a custom field
post
Deletes an answer option.
post
Verifies if the question key is already in use or not.
get
GtoInvitationsV1
Accepts the GTO Invite and creates the GTO and the GTO Admin's account.
post
Links user account to GTO.
post
Gets the Invited GTOs for a given Company.
get
Invites one or more GTO by Email Address and GTO Contact Name
post
Gets the Invited GTO for a given Company.
get
Resends the GTO Invite to the email address associated.
post
GtoReservationActivitiesV1
Gets the Reservation Activity broken down by occurrences within a given Date Range.
get
GtoReservationsV1
Adds an event reservation.
post
Presents the GTO Reservation review.
post
Finalizes the GTO Reservation and generates all of the Occurrence Intervals.
post
Activates the GTO Reservation.
post
Deactivates the GTO reservation.
post
Gets the GTO Reservation by Id.
get
Gets the GTO Reservations for a given Site..
get
Adds exception dates to the Reservation.
post
Releases the Event's Reservation Occurrence for a given GTO.
post
Releases multiple reservations for the criteria specified.
post
Gets the GTO allocated Recurrence Patterns for a given Event.
get
Gets the Reservation's Selections and its available time slots (optionally).
get
Adds a Date selection to reservation.
post
Adds the Reservations's Time Slot Selections.
post
Creates the GTO Order.
post
GtoSetupV1
Adds GTO event access setting.
post
Inserts or updates the existing Daily GTO Quota.
post
Gets the Events that a GTO can select from.
get
Archives the GTO Event setup.
post
Restores the GTO Event setup.
post
Gets GTO event access setting time slots.
get
Adds GTO event access setting time slots.
post
Adds GTO event access setting ticket types.
post
Adds GTO event access setting tiers.
post
Gets GTO event access setting with time slots, ticket types, tiers, date restrictions.
get
Adds or Updates the GTO purchase cutoff rules.
post
Activates GTO event access ticket type quota.
post
Deactivates GTO event access ticket type quota.
post
Activates GTO event access tier type quota.
post
Deactivates GTO event access tier type quota.
post
Adds pricing override to the tier.
post
Adds the pricing overrides for multiple tiers for a given setup.
post
Updates GTO event access setting time slot quota.
put
Updates GTO event access setting ticket type quota.
put
Updates GTO event access setting tier quota.
put
Deletes GTO event access setting time slot selection.
del
Deletes GTO event access setting ticket type.
del
Deletes GTO event access setting tier.
del
Adds a Hourly recurrence date restriction.
post
Adds a Weekly recurrence date restriction.
post
Adds a Monthly recurrence date restriction.
post
Adds a Yearly recurrence date restriction.
post
Updates a Hourly recurrence date restriction.
put
Updates a Weekly recurrence date restriction.
put
Updates a Monthly recurrence date restriction.
put
Updates a Yearly recurrence date restriction.
put
Gets Gto Event Access Setting Date Restrictions. If 'includeArchived' is set to 'true', will return archived restrictions as well.
get
Adds one or more GTO event access date restriction exception Date/Times.
post
Deletes GTO event access exception date.
del
Archive GTO event access date restriction.
post
Restore GTO event access date restriction.
post
GtosV1
Gets the logged in User's GTO.
get
Lists the GTOs for a given site.
get
Get the GTO By Id.
get
Updates the GTO info.
put
Activates Gto admin.
post
Deactivates Gto admin.
post
Gets GTO site setting.
get
Adds GTO billing schedule.
post
Adds GTO payment information.
post
Updates the Payment info for the given Payment method.
put
Adds a per GTO allocation percentage quota.
post
InstallmentsV1
Adds the Event Installment Options (mandatory/optional)
post
Gets the Event's Installment plans.
get
Adds an Installment plan for the Event.
post
Updates the Installment.
put
Archives the Installment.
put
Restores the Installment.
put
Activates the Installment Plan.
put
Deactivates the Installment Plan.
put
Regenerates Installments for an Order for which installments not generate.
patch
Charges the installment transaction manually.
post
Requeues a failed installment for processing.
post
Gets the Orders with Failed installments.
get
InventoryStockV1
Gets the Inventory Stock Items associated with a given Site.
get
Kicc
Gets the Kicc's submission form
post
/api/public/sites/{siteId}/orders/{orderId}/kicc
post
MediaV1
Allows to upload files like images, css, documents, etc.
post
Allows to upload files like images, css, documents, etc for company.
post
OccurrenceSettingsV1
Updates multiple time slot inventories.
post
Saves or overrides an existing Occurrence inventory with the provided Inventory.
post
Gets the Occurrence Inventory Overrides by Ticket Types.
get
Archives the Occurrence Inventory Status.
post
Saves the Occurrence On/Off Rules.
post
Gets the Occurrence's On-Off Rules.
get
Adds TimeSlot Override.
post
Deletes Event Day Override.
del
Publishes Time Slot Override
put
Unpublishes Time Slot Override
put
Sets Time Slot Override on sale.
put
Sets Time Slot Override not on sale.
put
Lists Event Day Overrides.
get
Gets Event Day Override for a Day.
get
Deletes Event Day Override.
del
OffersV1
Gets the Offers for an event.
get
Assign offers to an event
post
Gets an Offer by Id
get
Updates an existing Offer
put
Activate an event offer
put
Deactivate an event offer
put
Archive an event offer
put
Restore an archived event offer
put
Adds an Affiliate to the Exclusive Affiliate List.
post
OrdersV1
Gets the Order list based upon the filter criteria.
get
Filters the Orders based on the criteria provided.
post
Gets order based on the order Id. If HTTP headers are set with an accept type of 'text/fgl', then will return the Order's FGL that can be used for BOCA printing. If 'html' format or accept type of 'text/html' is used, then it will return the Order in HTML format.
get
Gets order based on the order Id. If HTTP headers are set with an accept type of 'text/fgl', then will return the Order's FGL that can be used for BOCA printing. If 'html' format or accept type of 'text/html' is used, then it will return the Order in HTML format.
get
Gets the Order Transfer history for a given order.
get
Checks in an entire Order and its tickets. If Event Id/Occurrence are passed, then will only check-in the tickets that match the criteria. For bundled tickets, will check in any companion tickets that match the criteria.
post
Gets shipping information for the order.
get
Updates information for the order.
put
Updates the Purchaser Info.
put
Gets billing information for the order.
get
Updates billing information for the order.
put
Gets line item (Ticket/Product) within order.
get
Gets ticket information for the based on line item and order.
get
Gets ticket information based on ticketId and order Id. If format is set to 'fgl' or HTTP Headers Accept type is set to 'text/fgl', then will return the FGL content for the ticket. If format is set to 'thermal' or HTTP Headers Accept type is set to 'application/pdf' will print Thermal/PDF tickets.
get
Transfers the line item from one time slot to another.
post
Transfers multiple line items from a given order to a new one.
post
Gets Tickets for the order id.
get
Cancels one or more of the Order's Tickets.
post
Changes the Card associated with the Order if there's an oustanding payment associated with the order.
put
Sends the Email that allows a user to change their Card information.
post
Refunds an Order with a specific amount
put
Sends the confirmation email.
post
Resends the installment confirmation email.
post
Gets the Order Transaction Info.
get
Startes the ticket transfer process by validating input and reserving new seats.
post
Finalizes the ticket transfer process by charging/refunding if needed and re-assigning seats.
post
Cancels the ticket transfer process. Releases new seats and cancels the whole process.
post
Processes the Order's Installments.
post
Calculates the Order's Billing.
get
Decrypts the Order.
post
OutletsV1
Gets Outlets for a given site.
get
Adds an Outlet for a given site.
post
Gets Outlet information for a given site.
get
Updates an Outlet for a given site.
put
Activates an Outlet for a given site.
put
Deactivates an Outlet for a given site.
put
Archives an Outlet for a given site.
put
Restores an Outlet for a given site.
put
Gets the Outlet's Event Assignments (both Exclusive and Blacklisted) for a given Site.
get
Adds an Outlet Level Event Assignment.
post
Updates an Outlet Level Event Assignment.
put
Deletes a previously added Outlet Event Assignment.
del
Adds an Outlet Level Blacklisted Event Assignment.
post
Updates an Outlet Level Blacklisted Event Assignment.
put
Deletes a previously added Outlet Blacklisting Event Assignment.
del
Gets tracking codes for a given outlet.
get
Adds an outlet Tracking code to the site.
post
Gets the Outlet code by Id.
get
Updates an outlet Tracking code to the site.
put
Activates Outlet tracking code.
put
Deactivates Outlet tracking code.
put
Archives Outlet tracking code.
put
Restores Outlet tracking code.
put
Gets the Outlet code by Id.
get
Adds priced event assignments for a given Outlet Code.
post
Updates the event assignments for a given Outlet Code.
put
Removes an Event Assignment from an Outlet code.
del
Blacklists an event from the Outlet Code.
post
Updates the existing Blacklisted Event's criteria.
put
Removes a blacklisted event from the list.
del
Lists an Outlet's Admins.
get
Adds an Outlet Admin if one isn't already added. Administrators should be globally unique within the system.
post
Activates a previously deactivated Outlet Admin.
put
Deactivates an Outlet Admin.
put
Archives an Outlet Admin.
put
Restores a previously archived Outlet Admin.
put
Adds an Outlet Admin if one isn't already added. Administrators should be globally unique within the system.
put
Changes role from Outlet admin to cashier or vice versa.
put
Gets Outlets Statistics.
get
Gets Statistics for an Outlet.
get
Gets Outlets Graph.
get
Gets Graph for an Outlet.
get
Gets Outlets Orders.
get
Gets Orders for an Outlet.
get
Gets Outlets Report.
get
Gets Report for an Outlet.
get
PaymentProcessorsV1
Gets the Payment processor for the given Id.
get
Deletes the payment processor
del
Gets the list of payment processor
get
Adds Stripe Settings for payment processor.
post
Adds AuthNet Settings for payment processor
post
Adds a Freeway Processor to the System.
post
Adds a Kicc Processor to the System.
post
Updates the Freeway Processor Settings.
put
Update Stripe Settings.
put
Update Kicc Settings.
put
Updates AuthNet setting.
put
Archives payment processor
put
Restores a previously archvied payment processor
put
Enables a given Payment Processor.
put
Disables a given Payment Processor.
put
Revokes Square access token.
post
Refreshes Square Access Token.
post
Adds a Square E-Commerce Processor to the system.
post
Updates the Square E-Commerce Processor.
put
Adds a Latitude Technology Processor to the system.
post
Updates Latitude Technology setting.
put
Adds a Asia Pay Processor to the system.
post
Updates Asia Pay setting.
put
PlugsV1
Gets a list of plugs.
get
Gets a given plug by Slug Name.
get
Gets a list of core plugs.
get
PremierV1
Imports Premier Tickets in the system.
post
Adds a premier site into the system. If 'createCompany' is set to true, then Company Name and Domain information must be passed. If Company Admin and Password are passed, then a new company Admin with the provided credentials will be created.
post
PriceChangeRulesV1
NEW/FINAL - Gets the Discount Rules
get
NEW/FINAL - Adds sophisticated Discount rules for bulk purchases for tickets.
post
Returns a list of quantity based pricing rules for the event.
get
Returns a quantity based pricing rules for the event.
get
Update an existing quantity based pricing rule.
put
Delete an existing quantity based pricing rule.
del
Add a new quantity based pricing rules to the event.
post
Update the archive status of an existing quantity based pricing rule.
put
Update the active status of an existing quantity based pricing rule.
put
ProductCategoriesV1
Deletes a Product Category if it isn't being used.
del
Creates a Product Category for a given company.
post
Updates the Product Category
put
ProductStoresV1
Publishes/Activates a store.
put
Adds a Product to a Store.
post
Removes a Product from a Store.
del
Archives a Store
put
Assigns a Product Store to an Event.
post
Gets the Product Stores.
get
Adds Company Product Store.
post
Unpublishes or deactivates a store.
put
Restores a store.
put
PromoCodesV1
Adds multiple promo codes to a site based on the criteria provided.
post
Gets the Promo Code Report for a given Date Range.
get
Gets the Promo Code Report for a given Date Range.
get
Gets the list of promo codes for Site.
get
Adds promo code for Site.
post
Filters the Promo Codes based on the criteria provided.
post
Gets promo code for Site.
get
Updates promo code for Site.
put
Archives the promo code for site.
post
Restores a given Promo code.
post
Deactivates the Promo code.
post
Activates the Promo code.
post
Gets promo code group for Site.
get
Updates promo code group for Site.
put
Gets a list of promo codes for Site.
get
Adds promo code group for Site
post
Archives the promo code group for Site.
post
Blacklists event from usage of promo code.
post
Blacklists ticket type from usage of promo code.
post
Blacklists ticket tier from usage of promo code.
post
Adds ticket type for the usage of promo code.
post
Adds ticket tier for the usage of promo code.
post
Adds event for the usage of promo code.
post
PublicV1
Gets the event based on the event Id and Site Id.
get
Gets event based on unique event url.
get
Gets package event based on unique event url.
get
Gets the list of events for the site.
get
ReceiptsV1
Gets receipt settings.
get
Saves receipt settings.
post
Changes logo of header in receipts.
put
RedisV1
Flushes the Redis DB.
del
Gets the Redis Entry for a specific key.
post
Removes the Cached Event.
del
Flushes the Site Event data
del
Removes the Cached entry based on a given key.
del
ReportsV1
Gets the Event Ticket Sales for each day of the Event occurrence in the specified date range.
post
Gets the Daily Sales Report.
post
Gets the Event Manifest Report for a given event, date (or a range if passed) or seated section.
post
Gets the Event's Sales Report by Categories assigned to Ticket Types and Tiers.
get
Gets the Event's Sales Report by date.
get
Gets the Event's Sales Report by tier.
get
Gets the Event's Sales Report by tier.
get
Gets the Geography Report. Valid Report Types are 'ByStateProvince', 'ByCountry', or 'ByZipCode'. If 'ByStateProvince' is chosen, then Country code must be passed. If 'excel' is passed or Accept-Type of "Accept : application/vnd.ms-excel" value is passed in Http Headers, will provide an Excel
post
Generates the Inventory Report
post
Gets the Reconciliation Report.
post
Gets the Ticket Check-In Summary. If the event is a part of the season event, it will get the season event infomation as well.
post
Gets the Tickets by Time slot report.
post
Gets the Time Slot Summary.
post
Gets the Transaction Summary for a given date (or a range if passed). All reports will be run from midnight to 11:59.59pm in the Site's local timezone.
get
Gets the Sales by Sales Person report.
post
Imports Events, GTOs, Outlets and Affiliates to data warehouse
post
Imports Orders to data warehouse
post
Gets the Country Geography Report. If 'excel' is passed or Accept-Type of "Accept : application/vnd.ms-excel" value is passed in Http Headers, will provide an Excel
post
Gets the State Geography Report. Country code must be passed for state report. If 'excel' is passed or Accept-Type of "Accept : application/vnd.ms-excel" value is passed in Http Headers, will provide an Excel
post
Gets the Zipcode Geography Report. Country code and state code must be passed for zipcode report. If 'excel' is passed or Accept-Type of "Accept : application/vnd.ms-excel" value is passed in Http Headers, will provide an Excel
post
Gets the Event Manifest Report for a given event, date (or a range if passed) or seated section.
post
SalesReportsV1
Gets the site sales overview.
get
Gets the Ticket Sales Statistics for a given site.
get
Gets Event Ticket Sales Statistics for a given site.
get
Gets the daily site sales for the given date range.
get
Gets the Event Sales Summary.
get
Gets the Occurrence Stats for a given Event. If the Event is a non-recurring event, pass a null to obtain the Event's stats.
post
SalesRepsV1
Lists the Sales Reps inside the system.
get
Assigns a Sales Rep to a given Site.
post
Gets the Sales Reps for a given site.
get
Lists the Sales Rep Sites.
get
ScanningDevicesV1
Add a Scanning Device
post
Gets a Scanning Device by Id
get
Updates an existing Scanning Device
put
Assigns a Scanning Device to a Venue
put
Activate a scanning device
put
Deactivate a scanning device
put
Archive a Scanning Device
put
Restore an archived event offer
put
SeasonEventsV1
Adds Parent Events to an Event.
post
Removes an event from the parent list.
del
SeedDataV1
Gets a list of timezones.
get
Returns a Timezone by Id.
get
Gets a list of countries.
get
Gets a list of countries.
get
Gets the avaiable Locales for Internationalization.
get
Gets the states for a given country.
get
Gets the Payment Gateways that can be configured within the system.
get
Gets the Charge Options.
get
Gets the Credit Card Types that can be associated with the checkout.
get
Gets available currencies within the system.
get
Gets the Url types.
get
Gets the Ticket Guardian selection criteria.
get
Gets the Approval Types.
get
Gets an enumeration of event fields to display when printing receipts.
get
/api/seeds/webhook
post
Gets the Shopping Cart Page Types.
get
Gets the User Claim Types.
get
Gets the various claims.
get
Gets the Affiliate Payout Intervals.
get
Gets the Scanning Device Types.
get
Gets the Scanning Device Types.
get
Gets list of FGL command seed data.
get
SettingsV1
Gets the Policy settings.
get
Saves Policy settings for site.
post
Gets Analytics settings.
get
Saves Analytics settings for the site.
post
Gets Checkout settings.
get
Saves Checkout settings for the site.
post
Gets the Ticket Guardian settings.
get
Saves the Ticket Guardian settings for the site.
post
Gets a list of Checkout Widget Settings
get
Saves Checkout Widget settings for the site.
post
Gets the Checkout Widget Settings By Id.
get
Gets the Checkout Widget Settings By Id.
put
Archives a checkout Widget Setting.
put
Restores a previously archived checkout Widget Setting.
put
Gets the eTicket Settings by Site Id.
get
Saves i.e. adds or updates the site eTicket Settings.
post
Gets Smtp settings.
get
Saves Smtp settings for the site.
post
Gets customer settings.
get
Saves Customer settings for the site.
post
Gets customer settings.
get
Saves Customer settings for the company.
post
Gets stripe connect settings for Company.
get
Saves Stripe Connect settings for the Company.
post
Gets the Site Appearance Settings.
get
Saves the Site appearance Settings.
post
Gets the Site Appearance Settings.
get
Saves the Ice Cream Social's Social Networking settings.
post
Gets the site settings.
get
Saves site settings for the site.
post
Gets the site settings.
get
Saves site settings for the site.
post
Gets the Page Script Settings.
get
Upserts (adds or updates) a Page Script setting. If one exists, it will update, else will insert.
post
Gets the Site Script settings.
get
Deletes site setting based on setting Id.
del
Deletes company setting based on setting Id.
del
Synchronizes the settings into a read-only setting. Admin only calls.
post
Gets all of the site settings in a single call.
get
/api/sites/{siteId}/specific-settings
get
Gets currency conversion setting for a Site.
get
Adds new currency conversion setting.
post
Get currency conversion Setting By Id.
get
Updates currency conversion Setting.
put
Deletes currency conversion Setting.
del
ShippingMethodsV1
Gets list of Shipping Method.
get
Adds Shipping Method.
post
Gets Shipping Method By Id.
get
Updates Shipping Method.
put
Archives Shipping Method.
put
Restores Shipping Method.
put
Set Default Shipping Method.
put
Adds Tiered Price.
post
Delete Tiered Price.
del
Gets list of Event Shipping Method.
get
Adds Event Shipping Method.
post
Gets Event Shipping Method By Id.
get
Updates Event Shipping Method.
put
Delete Event Shipping Method.
del
Migrates the existing Sql Shipping Method to the new Mongo.
post
Migrates the existing Sql Event Shipping Method to the new Mongo.
post
ShippingV1
Gets the Flat Rate Shipping items.
get
Adds a Flat Rate Shipping Criteria to the site.
post
Gets Flat Rate Shipping criteria by id.
get
Updates a Flat Rate Shipping Criteria.
put
Archives a Flat Rate Shipping.
put
Restores a previously archived Flat Rate Shipping.
put
Gets the Flat Rate Shipping Costs by Flat Rate Shipping id.
get
Adds a Flat Rate Shipping Cost.
post
Updates the Flat Rate Shipping Cost.
put
ShoppingCartV1
Initializes a new shopping cart instance for the User. If a cart already exists, appropriate error message is shown. Only Administrators will be able to create an order in the Box Office mode.
post
Gets the shopping cart based on cart Id.
get
Abandons the cart.
del
Links a User's account with a cart.
post
Adds the Shipping information required for the checkout process.
post
Adds the Billing Information for the Cart.
post
Signs the Waivers needed for the Ticket purchase.
post
Validates the cart by verifying all the required conditions are met.
post
Initiates the Checkout process by checking out the user's shopping cart.
post
Initiates the Checkout process for a kicc checkout by checking out the user's shopping cart.
post
Initiates the Checkout process for a square readerSDK device by checking out the user's shopping cart.
post
Applies the installment plan to the cart.
post
Gets the Installment Plan and their Payment Summary for the cart.
get
Adds tickets to cart. Can add multiple tiers to cart.
post
Gets the tickets associated with a given Cart Line Item.
get
Redeems a given Promo Code.
post
Removes all instances of the used Promo Code from cart.
del
Removes a ticket from the cart.
del
Updates the quantity of tickets for the given line Item. If the new quantity is greater than the old quantity, new tickets are added. If new quantity is less than old quantity, tickets are removed if and only if they are empty. If Attendee info exists for any tickets, it will not let you update the quantity.
post
Removes a Line Item from the Cart.
del
FINAL: Updates the Attendee Information.
put
Removes a given Attendee from a given Ticket.
del
Adds attendee info if one doesn't exist. Updates it if it is already available.
patch
FINAL - Saves answer information of the event questions for Attendee.
put
Inserts or updates the purchaser details.
post
Saves answer information of the event questions for Purchasers.
put
Gets the Purchaser Questions associated with a given Cart.
get
Saves the Purchaser Answers associated with a given Cart.
post
Gets the Shipping Methods for each tier in the cart.
get
Saves the Order Shipping Methods and calculates the Shipping Costs.
post
Gets one or more Cart Offers.
get
Gets the Cart's Payment Options.
get
/api/public/sites/{siteId}/shopping-carts/{cartId}/mobile-authorization
post
SiteProductAttributesV1
Gets the site's product attributes
get
Adds a Product Attribute with its options.
post
SiteProductsV1
Adds a Site Product.
post
Gets a Site Product by Id.
get
Updates the Product based on product id.
put
Assigns a Shipping Class to a given Product.
post
Adds a Variant Product to the system.
post
Adds a product variation.
post
Archives a Product. If the product has variants, then it will archive the variants as well.
put
Restores a given product. If the product has variants, it will not restore the variants. Each variant needs to be individually restored.
put
Gets site products.
get
Adds a Product Photo.
post
Deletes a product photo.
del
Sets a Primary Photo.
put
Assign product attribute options.
post
SiteShippingClassesV1
Gets the Shipping Classes configured for a given site.
get
Adds a Shipping class.
post
Gets the Shipping Class by Code.
get
Updates the Shipping Class by code.
put
Activate a Shipping Class.
put
Deactivates a Shipping Class.
put
Archives a Shipping Class.
put
Restores a previously archived Shipping Class.
put
SitesV1
Gets the sites managed by a given user.
get
Gets the site information by abbreviation.
get
Gets the Site information by Id.
get
Gets the Sites configured for a given company.
get
Adds a Site for a given Company.
post
Gets the Site information.
get
Updates the Site information.
put
Publishes the Site.
put
Un-publishes the Site.
put
Activates the Site.
put
De-activates the Site.
put
Restores a Site.
put
New: Gets Site administrators, optionally based on one or more roles.
get
Allows system administrator to add Site Administrator.
post
Links an existing Administrator to the current site.
post
Gets the Site Admin if the calling user has the necessary permissions.
get
Updates the User info.
put
Allows an administrator or super admin to change password of its members.
post
Allows system administrator to Deactivate Site administrator.
put
Allows system administrator to Activate Site administrator.
put
Allows system administrator to Archive Site administrator.
put
Allows system administrator to Restore Site administrator.
put
Gets the Site Plugs by Site Id.
get
Installs plug for the given Site Id.
post
Activates the Plug for the Site Id.
put
Checks whether a given Site plug is installed or not.
get
Deactivates the Plug for the Site Id.
put
Uninstalls plug for the given Site Id.
post
Gets site logo.
get
/api/sites/{siteId}/logo
post
Deletes site logo.
del
Update the Tenant Profile.
put
Enables PII Encryption for a site.
post
Disables PII Encryption for a site.
post
StoreV1
/api/sites/{siteId}/stores
get
/api/sites/{siteId}/stores
post
/api/sites/{siteId}/stores/{storeId}
get
/api/sites/{siteId}/stores/{storeId}
put
StripeConnectV1
Gets the Redirect URL to use for a given site. This URL needs to be added to the Primary Account Holder's Stripe Connect Redirect URL list.
get
Gets the Stripe Connect button URL for the given Site for Development mode.
get
Gets the Stripe Connect button URL for the given Site for Live mode.
get
Processes the Stripe Connect Response.
post
Gets Stripe connect split settings for company.
get
Adds stripe connect split setting for company.
post
Gets stripe connect split settings.
get
Updates stripe connect split setting.
put
Removes stripe connect split settings.
del
Gets split item.
get
Updates split item.
put
Deletes a split item from the Stripe Split Settings.
del
Gets stripe connect settings for Company.
get
Saves Stripe Connect settings for the Company.
post
Adds Stripe Connect Settings for the Secondary Payment processor.
post
Updates the settings of the Secondary Stripe Connect Processor.
put
Updates development settings for stripe connect processor.
put
Updates live settings for stripe connect processor.
put
Gets the stripe connect payment processors
get
TemplatingV1
GEts the Template groups and the field.s
get
Adds a new Template Group to the system.
post
Adds a Template field to a template group.
post
/api/templating/groups/{groupId}
get
TicketCategoriesV1
Gets one or more Ticket Categories.
get
Adds a Ticket Category.
post
Gets the Ticket Category by Id.
get
Adds a Tier Category.
post
Adds a Ticket Type Category.
post
TicketPurchaseRulesV1
Adds a Standard Ticket Purchase Rule targeting one or more events for a given Site.
post
Adds a sub-group to a Standard Purchase Rule.
post
TicketsV1
Gets a list of Events for a ticket.
get
Gets a Ticket by Id.
get
Redeems the ticket by bar code.
post
Deletes the Ticket Redemption and marks the Ticket as active.
post
TicketTypesV1
Gets a ticket Type for the given id
get
Gets ticket types for a given Event.
get
Adds a Ticket Type for a given Event.
post
Reorders the Ticket Types in the order of ids passed.
post
Reorders the Ticket Tiers in the order of ids passed.
post
Updates the Ticket Type information.
put
Clones a given Ticket Type.
post
Clones the tier.
post
Moves a ticket tier from one to another.
post
Gets the pricing tiers based on the ticket type Id.
get
Adds pricing tiers to a given ticket type
post
Gets Pricing Tier based on the Ticket Tier Id.
get
Updates the pricing tier information for a given Ticket Type
put
Adds custom data to an existing tier.
post
Updates the tier's custom data element.
put
Deletes the tier's custom data element.
del
Marks a given Tier as featured.
put
Removes a given Tier's featured status.
del
Get publishing options for the ticket type.
get
Sets a ticket type on sale.
put
Removes the on-sale status of the ticket type and its tiers
del
Set publish status of simple ticket type.
put
Unpublishes the ticket type and all its tiers.
del
Hides the ticket type from list status. This is used for Private Ticket Types that are available for internal use only. This allows setting a ticket on sale but hiding it from the public view.
put
Shows the ticket type from list status.
put
Gets pricing tier publishing options.
get
Sets pricing tier on sale.
put
Removes on-sale status of the pricing tier.
del
Shows pricing tier from the list status.
put
Hides pricing tier from the list status.
del
Publishes pricing tier.
put
Unpublishes pricing tier.
del
Blocks promo code for ticket type.
put
Allows promo code for ticket type.
put
Gets the description settings for a ticket type.
get
Saves/Updates the descriptions for ticket type.
put
Gets description information for the pricing tier.
get
Saves the descriptions for pricing tiers.
put
Archives ticket type.
put
Restores a ticket type.
put
Archives pricing tier.
put
Restores pricing tier.
put
TierTypeV1
Gets Tier Types.
get
Adds Tier Type.
post
Gets Tier Type based on the Id.
get
Updates Tier Type.
put
UserOrdersV1
Gets the User's Orders.
get
Cancels the Order.
post
Gets a User's Events.
get
Transfers an Order's tickets.
post
UsersV1
Upserts the User's billing info. If 'self' is passed, will upsert the logged in user's billing info. If the User Id is passed, will update the user's billing info if and only if the user has permissions to update the User's billing info.
post
Gets the User's info by the User Id. If 'self' is passed, will get the logged in User's Id. Else will get the User's info provided the user requesting has access to the target user's info.
get
Update's the User's Account information.
put
Gets the User's info based on the domain. If no domain is passed, a root admin is assumed and will be looked up.
get
Gets the Companies a user can manage.
get
/api/users/sites
get
Gets a User's sites.
get
Archives a user.
put
Restores a previously archived user.
put
Activates a given user.
put
Deactivates a given user.
put
Gets the logged in User's information.
get
VenuesV1
Gets list of venues for the SiteId
get
Adds a venue to the system.
post
Clones a venue by copying Name, Configuration, Address.
post
Gets the Venue for the specified Id.
get
Updates the venue.
put
Deletes a venue for a given site.
del
Archives a given venue.
put
Uploads the Section's SVG.
post
Restores a given venue.
put
Assigns the Seated Venue to a given site.
post
Gets a list of the Venue Sections.
get
Adds a section to Venue.
post
Gets a Venue's Section.
get
Updates the Section for a given Venue.
put
Deletes the Section from a venue.
del
Clones a section by copying Title, Key, Rows, Seats.
post
Uploads the Section's SVG.
post
Adds or Updates the Section Seating Info. If a Row already exists for a new one being added, the new information will overwrite this info.
post
Sets the Row Order.
post
Adds seat to a specified section/row.
post
Deletes a Row from the specified Section.
del
Adds or Updates a Row's seating information.
post
Deletes seat from a row.
del
Sets the Seat Order.
post
Adds a Seat as an Accessible Seat for a given section.
post
/api/sites/{siteId}/venues/{venueId}/sections/{sectionKey}/rows/{rowKey}/seats/{seatKey}/accessible-seating
del
Gets Venue Levels.
get
Adds a Venue level to a given Venue.
post
Updates a Venue level to a given Venue.
put
Deletes a Venue level to a given Venue.
del
Uploads image for an Event.
post
Uploads image for an Event.
del
WaiversV1
Gets a list of Waivers.
get
Adds a new Waiver.
post
Gets a Waiver for the given Id.
get
Update Waiver.
put
Delete Waiver.
del
Get All EventWaivers for an Event
get
Assign waivers to events
post
Removes waiver assigned to Event
del
Powered by
Adds a Square E-Commerce Processor to the system.
Ask AI
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
