Jump to Content

Guides Discussions

Home Guides API Reference Changelog Discussions

v1.0

Guides Discussions

API Reference

v1.0

Authorisation Header

Auth header testget

Widgets

/widgetspost

Table of contents

Page 1
Page 2
Page 3

Required path params

Test removing required labelget

Swagger Petstore

pet
store
user

Basic Auth

Basic auth no passwordget

Yian's 404 API

200get
404get

Test manual

Testget

Test manual

Postpost

Redirect API

Redirect testget

readme.io updated 2

/
- getget
Swagger

Test image in html block

Test image in html blockget

TicketSocket.Api

AccountsV1
AffiliatesV1
ApiClientsV1
- Adds an API Key for a given User.post
- Adds a new api client.post
BillingRulesV1
BillingServiceV1
BoxOfficeV1
- Gets the Box Office Settings for a Logged In User.get
BulkDiscountsV1
CompaniesV1
CustomFieldGroupsV1
DomainsV1
EventBookingsV1
EventBundlingV1
- Adds the Tier bundling criteria.post
EventFeesV1
EventOptionsV1
- Clones an Event and its Ticket Types.post
EventPackagesV1
EventPreSalesV1
EventProductAssignmentsV1
EventQuestionsV1
EventRecurrencesV1
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
EventsMediaV1
EventsV1
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
FieldsV1
GtoInvitationsV1
GtoReservationActivitiesV1
- Gets the Reservation Activity broken down by occurrences within a given Date Range.get
GtoReservationsV1
GtoSetupV1
GtosV1
InstallmentsV1
InventoryStockV1
- Gets the Inventory Stock Items associated with a given Site.get
Kicc
- Gets the Kicc's submission formpost
- /api/public/sites/{siteId}/orders/{orderId}/kiccpost
MediaV1
- Allows to upload files like images, css, documents, etc.post
- Allows to upload files like images, css, documents, etc for company.post
OccurrenceSettingsV1
OffersV1
OrdersV1
OutletsV1
PaymentProcessorsV1
PlugsV1
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
ProductCategoriesV1
ProductStoresV1
PromoCodesV1
PublicV1
ReceiptsV1
RedisV1
ReportsV1
SalesReportsV1
SalesRepsV1
ScanningDevicesV1
SeasonEventsV1
- Adds Parent Events to an Event.post
- Removes an event from the parent list.delete
SeedDataV1
SettingsV1
ShippingMethodsV1
ShippingV1
ShoppingCartV1
SiteProductAttributesV1
- Gets the site's product attributesget
- Adds a Product Attribute with its options.post
SiteProductsV1
SiteShippingClassesV1
SitesV1
StoreV1
StripeConnectV1
TemplatingV1
TicketCategoriesV1
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
TicketTypesV1
TierTypeV1
UserOrdersV1
UsersV1
VenuesV1
WaiversV1

Powered by

Archives an Outlet Admin.

put https://example.com/api/sites/{siteId}/outlets/{outletId}/administrators/{adminUserId}/archive

Language

Click Try It! to start a request and see the response here!