{"items":[{"type":"link","label":"TickeTing REST API v3 Reference","link":"/openapi","routeSlug":"/openapi"},{"type":"link","label":"Introduction","link":"/openapi/section/introduction","routeSlug":"/openapi/section/introduction"},{"type":"group","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication","items":[{"type":"link","label":"Example Request Header","link":"/openapi/section/authentication/example-request-header","routeSlug":"/openapi/section/authentication/example-request-header"},{"type":"link","label":"Authentication Errors","link":"/openapi/section/authentication/authentication-errors","routeSlug":"/openapi/section/authentication/authentication-errors"}]},{"type":"group","label":"Client Version","link":"/openapi/section/client-version","routeSlug":"/openapi/section/client-version","items":[{"type":"link","label":"Example Request Header","link":"/openapi/section/client-version/example-request-header","routeSlug":"/openapi/section/client-version/example-request-header"},{"type":"link","label":"Client Version Errors","link":"/openapi/section/client-version/client-version-errors","routeSlug":"/openapi/section/client-version/client-version-errors"}]},{"type":"group","label":"Error Responses","link":"/openapi/section/error-responses","routeSlug":"/openapi/section/error-responses","items":[{"type":"link","label":"404 Errors","link":"/openapi/section/error-responses/404-errors","routeSlug":"/openapi/section/error-responses/404-errors"},{"type":"link","label":"Server Errors","link":"/openapi/section/error-responses/server-errors","routeSlug":"/openapi/section/error-responses/server-errors"},{"type":"link","label":"Other Errors","link":"/openapi/section/error-responses/other-errors","routeSlug":"/openapi/section/error-responses/other-errors"}]},{"type":"separator","label":"Authentication"},{"type":"group","label":"Session Authentication","link":"/openapi/session-authentication","routeSlug":"/openapi/session-authentication","items":[{"label":"Start a new API session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/session-authentication/start_session","routeSlug":"/openapi/session-authentication/start_session","metadata":{"seo":{"title":"Start a new API session","description":"When provided with a valid username/email address and password, starts a new API session, returning the associated key."}},"httpPath":"/sessions"},{"label":"Retrieve an active API session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/session-authentication/continue_session","routeSlug":"/openapi/session-authentication/continue_session","metadata":{"seo":{"title":"Retrieve an active API session","description":"Returns details of the user's active API session. The session returned is based on the key used to authenticate the request."}},"httpPath":"/sessions/active"},{"label":"End an active API session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/session-authentication/end_session","routeSlug":"/openapi/session-authentication/end_session","metadata":{"seo":{"title":"End an active API session","description":"Ends the user's active API session based on the key used to authenticate the request."}},"httpPath":"/sessions/active"}]},{"type":"group","label":"Token Authentication","link":"/openapi/token-authentication","routeSlug":"/openapi/token-authentication","items":[{"label":"Retrieve token key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/token-authentication/retrieve_token_auth","routeSlug":"/openapi/token-authentication/retrieve_token_auth","metadata":{"seo":{"title":"Retrieve token key","description":"Returns authentication key and netadata for an event admissions token. Authenticating requests with the returned key will grant access to endpoints needed for ticket redemption."}},"httpPath":"/tokens/{code}"}]},{"type":"group","label":"API Integrations","link":"/openapi/api-integrations","routeSlug":"/openapi/api-integrations","items":[{"label":"Create new integration token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api-integrations/create_integration","routeSlug":"/openapi/api-integrations/create_integration","metadata":{"seo":{"title":"Create new integration token","description":"Create an API integration token that can be used to authenticate requests instead of a session key. Integrations should be used where user interaction is not desirable/possible or for server to server applications."}},"httpPath":"/integrations"}]},{"type":"separator","label":"User Accounts"},{"type":"group","label":"Account Management","link":"/openapi/account-management","routeSlug":"/openapi/account-management","items":[{"label":"List user accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/list_accounts","routeSlug":"/openapi/account-management/list_accounts","metadata":{"seo":{"title":"List user accounts","description":"Retrieve a list of TickeTing user accounts."}},"httpPath":"/accounts"},{"label":"Create a new account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/create_account","routeSlug":"/openapi/account-management/create_account","metadata":{"seo":{"title":"Create a new account","description":"Create a new TickeTing user account. Most user data is optional for account creation, so there is flexibility in the stage of the onboarding process at which data is captured."}},"httpPath":"/accounts"},{"label":"Retrieve account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/retrieve_account","routeSlug":"/openapi/account-management/retrieve_account","metadata":{"seo":{"title":"Retrieve account details","description":"Returns details of the specified user account."}},"httpPath":"/accounts/{number}"},{"label":"Modify account details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/update_account","routeSlug":"/openapi/account-management/update_account","metadata":{"seo":{"title":"Modify account details","description":"Update the details of the specified user account"}},"httpPath":"/accounts/{number}"},{"label":"Remove an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/delete_account","routeSlug":"/openapi/account-management/delete_account","metadata":{"seo":{"title":"Remove an account","description":"Completely remove an account from the system. An account can only be deleted if it does not currently hold tickets to upcoming events."}},"httpPath":"/accounts/{number}"},{"label":"Retrieve account preferences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/retrieve_account_preferences","routeSlug":"/openapi/account-management/retrieve_account_preferences","metadata":{"seo":{"title":"Retrieve account preferences","description":"Returns the user preferences for the account."}},"httpPath":"/accounts/{number}/preferences"},{"label":"Update account preferences","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/update_account_preferences","routeSlug":"/openapi/account-management/update_account_preferences","metadata":{"seo":{"title":"Update account preferences","description":"Make changes to the account's user preferences"}},"httpPath":"/accounts/{number}/preferences"},{"label":"List account privileges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/list_account_privileges","routeSlug":"/openapi/account-management/list_account_privileges","metadata":{"seo":{"title":"List account privileges","description":"Retrieve a list of privileges granted to this user to manage various system resources."}},"httpPath":"/accounts/{number}/privileges"},{"label":"List privileged hosts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/list_account_hosts","routeSlug":"/openapi/account-management/list_account_hosts","metadata":{"seo":{"title":"List privileged hosts","description":"Retrieve a list of host resources for which this account has been granted access privileges."}},"httpPath":"/accounts/{number}/hosts"},{"label":"Lookup an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/lookup_account","routeSlug":"/openapi/account-management/lookup_account","metadata":{"seo":{"title":"Lookup an account","description":"Test the existenc of an account using its username or email address. A user role can optionally be provided to test for the existence of accounts of a certain type."}},"httpPath":"/lookups"}]},{"type":"group","label":"Account Verification","link":"/openapi/account-verification","routeSlug":"/openapi/account-verification","items":[{"label":"Request verification code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-verification/request_verification_code","routeSlug":"/openapi/account-verification/request_verification_code","metadata":{"seo":{"title":"Request verification code","description":"Request that an account verification code be sent to the provided email address, if it belongs to a registered user."}},"httpPath":"/verifications"},{"label":"Verify account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-verification/verify_account","routeSlug":"/openapi/account-verification/verify_account","metadata":{"seo":{"title":"Verify account","description":"Verify the account if the verification code matches that sent to the account's email address."}},"httpPath":"/verifications/{verification}"}]},{"type":"group","label":"Password Reset","link":"/openapi/password-reset","routeSlug":"/openapi/password-reset","items":[{"label":"Request password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/password-reset/request_reset","routeSlug":"/openapi/password-reset/request_reset","metadata":{"seo":{"title":"Request password reset","description":"Request that a password reset code be sent to the provided email address, if it belongs to a registered user."}},"httpPath":"/resets"},{"label":"Reset password","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/password-reset/reset_password","routeSlug":"/openapi/password-reset/reset_password","metadata":{"seo":{"title":"Reset password","description":"Change the password to the value provided if the reset code matches that sent to the account's email address."}},"httpPath":"/resets/{reset}"}]},{"type":"group","label":"Account Activation","link":"/openapi/account-activation","routeSlug":"/openapi/account-activation","items":[{"label":"Toggle account activation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activation/toggle_account","routeSlug":"/openapi/account-activation/toggle_account","metadata":{"seo":{"title":"Toggle account activation","description":"Deactivates the specified account if it is active, and activates it otherwise."}},"httpPath":"/accounts/{number}/toggles"},{"label":"Request account deletion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activation/request_deletion","routeSlug":"/openapi/account-activation/request_deletion","metadata":{"seo":{"title":"Request account deletion","description":"Notifies system administrators that the user would like to delete their account. When a deletion request is submitted, the account is immediately deactivated, and can no longer authenticate requests, pending review."}},"httpPath":"/accounts/{number}/deletions"}]},{"type":"group","label":"Account Activity","link":"/openapi/account-activity","routeSlug":"/openapi/account-activity","items":[{"label":"List API sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activity/list_api_session","routeSlug":"/openapi/account-activity/list_api_session","metadata":{"seo":{"title":"List API sessions","description":"Retrieve a list of API sessions opened by this user."}},"httpPath":"/accounts/{number}/sessions"},{"label":"Retrieve event itinerary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activity/view_event_itinerary","routeSlug":"/openapi/account-activity/view_event_itinerary","metadata":{"seo":{"title":"Retrieve event itinerary","description":"Retrieve a list of events, past and future, that the account has tickets for."}},"httpPath":"/accounts/{number}/events"},{"label":"Retrieve ticket wallet","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activity/list_ticket_wallet","routeSlug":"/openapi/account-activity/list_ticket_wallet","metadata":{"seo":{"title":"Retrieve ticket wallet","description":"Retrieve a list of tickets belonging to the specified account."}},"httpPath":"/accounts/{number}/tickets"},{"label":"View transfer history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activity/view_transfer_history","routeSlug":"/openapi/account-activity/view_transfer_history","metadata":{"seo":{"title":"View transfer history","description":"Retrieve the transfer history of the specified account."}},"httpPath":"/accounts/{number}/transfers"}]},{"type":"separator","label":"Events"},{"type":"group","label":"Managing Host Accounts","link":"/openapi/managing-host-accounts","routeSlug":"/openapi/managing-host-accounts","items":[{"label":"List event hosts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/list_hosts","routeSlug":"/openapi/managing-host-accounts/list_hosts","metadata":{"seo":{"title":"List event hosts","description":"Retrieve a list of registered event hosts that match the given criteria."}},"httpPath":"/hosts"},{"label":"Create an event host","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/create_host","routeSlug":"/openapi/managing-host-accounts/create_host","metadata":{"seo":{"title":"Create an event host","description":"Create a new host which can list and promote events, sell tickets or request add-on services through TickeTing. The authorising user account is automatically added to the event host's list of administrators upon creation."}},"httpPath":"/hosts"},{"label":"Retrieve host details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/retrieve_host","routeSlug":"/openapi/managing-host-accounts/retrieve_host","metadata":{"seo":{"title":"Retrieve host details","description":"Retrieve the registration details of the specified host."}},"httpPath":"/hosts/{host}"},{"label":"Update host details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/update_host","routeSlug":"/openapi/managing-host-accounts/update_host","metadata":{"seo":{"title":"Update host details","description":"Change the registered details of the specified event host"}},"httpPath":"/hosts/{host}"},{"label":"Remove an event host","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/delete_host","routeSlug":"/openapi/managing-host-accounts/delete_host","metadata":{"seo":{"title":"Remove an event host","description":"Completely remove a registered event host from the system. The host will no longer be able to list or promote events, sell tickets, or request add-on services through TickeTing. Any existing events listed under the removed host account will still be active in the system, and any tickets sold will remain valid."}},"httpPath":"/hosts/{host}"},{"label":"List host privileges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/list_host_privileges","routeSlug":"/openapi/managing-host-accounts/list_host_privileges","metadata":{"seo":{"title":"List host privileges","description":"Retrieve a list of all privileges granted on the host account."}},"httpPath":"/hosts/{host}/privileges"},{"label":"Grant a host privilege","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/grant_host_privilege","routeSlug":"/openapi/managing-host-accounts/grant_host_privilege","metadata":{"seo":{"title":"Grant a host privilege","description":"Grant a new privilege on the host account which allows the targetted user to perform a subset of management operations based on their assigned role."}},"httpPath":"/hosts/{host}/privileges"},{"label":"Retrieve host privilege","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/retrieve_host_privilege","routeSlug":"/openapi/managing-host-accounts/retrieve_host_privilege","metadata":{"seo":{"title":"Retrieve host privilege","description":"Retrieve details of the specified privilege."}},"httpPath":"/hosts/{host}/privileges/{privilege}"},{"label":"Update host privilege","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/update_host_privilege","routeSlug":"/openapi/managing-host-accounts/update_host_privilege","metadata":{"seo":{"title":"Update host privilege","description":"Update the role associated with the specified privilege"}},"httpPath":"/hosts/{host}/privileges/{privilege}"},{"label":"Revoke a host privilege","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/revoke_host_privilege","routeSlug":"/openapi/managing-host-accounts/revoke_host_privilege","metadata":{"seo":{"title":"Revoke a host privilege","description":"Revoke the specified privilege, denying the associated user all permissions to manage the host account."}},"httpPath":"/hosts/{host}/privileges/{privilege}"}]},{"type":"group","label":"Managing Events","link":"/openapi/managing-events","routeSlug":"/openapi/managing-events","items":[{"label":"List events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/list_host_events","routeSlug":"/openapi/managing-events/list_host_events","metadata":{"seo":{"title":"List events","description":"Retrieve a list of all events registered by this event host."}},"httpPath":"/hosts/{host}/events"},{"label":"Register an event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/register_event","routeSlug":"/openapi/managing-events/register_event","metadata":{"seo":{"title":"Register an event","description":"Register a new event in the TickeTing system. Once submitted for review and approved by an administrator, the host can begin to sell tickets to the event."}},"httpPath":"/hosts/{host}/events"},{"label":"Retrieve event details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/retrieve_event","routeSlug":"/openapi/managing-events/retrieve_event","metadata":{"seo":{"title":"Retrieve event details","description":"Retrieve details of the current revision of the requested event"}},"httpPath":"/hosts/{host}/events/{event}"},{"label":"Update event details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/update_event","routeSlug":"/openapi/managing-events/update_event","metadata":{"seo":{"title":"Update event details","description":"Change the details of the current revision of the requested event"}},"httpPath":"/hosts/{host}/events/{event}"},{"label":"Remove an event","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/delete_event","routeSlug":"/openapi/managing-events/delete_event","metadata":{"seo":{"title":"Remove an event","description":"Completely remove a registered event from the system. Only events that have not sold any tickets can be deleted. If tickets have been sold, but further sales should be prevented, an event can be unpublished or cancelled as necessary."}},"httpPath":"/hosts/{host}/events/{event}"},{"label":"List event submissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/list_event_submissions","routeSlug":"/openapi/managing-events/list_event_submissions","metadata":{"seo":{"title":"List event submissions","description":"Retrieve a list of event changes submitted for review."}},"httpPath":"/hosts/{host}/events/{event}/submissions"},{"label":"Submit event for review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/submit_event","routeSlug":"/openapi/managing-events/submit_event","metadata":{"seo":{"title":"Submit event for review","description":"Submit the current event revision for administrative review. All revisions to an event listing must be reviewd and approved before being published and made available to the public."}},"httpPath":"/hosts/{host}/events/{event}/submissions"},{"label":"List event publications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/list_event_publications","routeSlug":"/openapi/managing-events/list_event_publications","metadata":{"seo":{"title":"List event publications","description":"Retrieve a list of published revisions for this event."}},"httpPath":"/hosts/{host}/events/{event}/publications"},{"label":"Publish event changes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/publish_event","routeSlug":"/openapi/managing-events/publish_event","metadata":{"seo":{"title":"Publish event changes","description":"Publish the current revision to an event's listing. Once a revision is published, an event becomes publically visible. If this is not the first published revision, the event's listing is overriden with the revised changes."}},"httpPath":"/hosts/{host}/events/{event}/publications"}]},{"type":"group","label":"Managing Tiers","link":"/openapi/managing-tiers","routeSlug":"/openapi/managing-tiers","items":[{"label":"List tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/list_host_tiers","routeSlug":"/openapi/managing-tiers/list_host_tiers","metadata":{"seo":{"title":"List tiers","description":"Retrieve a list of all ticket tiers managed by the specified host."}},"httpPath":"/hosts/{host}/tiers"},{"label":"Create a tier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/create_tier","routeSlug":"/openapi/managing-tiers/create_tier","metadata":{"seo":{"title":"Create a tier","description":"Create a new tier for selling tickets to a registered event. Tiers define the price points a which tickets are to be sold, and metadata about how tickets issued under the tier should behave. Tiers can manage ticket sales for a single event, or a bundle of related events."}},"httpPath":"/hosts/{host}/tiers"},{"label":"Retrieve tier details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/retrieve_tier","routeSlug":"/openapi/managing-tiers/retrieve_tier","metadata":{"seo":{"title":"Retrieve tier details","description":"Retrieve full details of the requested tier"}},"httpPath":"/hosts/{host}/tiers/{tier}"},{"label":"Update tier details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/update_tier","routeSlug":"/openapi/managing-tiers/update_tier","metadata":{"seo":{"title":"Update tier details","description":"Change the details of the requested tier. Only tiers for which no tickets have been sold can be changed."}},"httpPath":"/hosts/{host}/tiers/{tier}"},{"label":"Remove a tier","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/delete_tier","routeSlug":"/openapi/managing-tiers/delete_tier","metadata":{"seo":{"title":"Remove a tier","description":"Completely remove a tier from the system. Only tiers for which no tickets have been sold can be deleted. If tickets have been sold, but further sales should be prevented, a tier can be expired."}},"httpPath":"/hosts/{host}/tiers/{tier}"}]},{"type":"group","label":"Event Listings","link":"/openapi/event-listings","routeSlug":"/openapi/event-listings","items":[{"label":"List all published events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-listings/list_published_events","routeSlug":"/openapi/event-listings/list_published_events","metadata":{"seo":{"title":"List all published events","description":"Retrieve a list of published events that match the given criteria."}},"httpPath":"/events"},{"label":"Retrieve event listing","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-listings/retrieve_published_event","routeSlug":"/openapi/event-listings/retrieve_published_event","metadata":{"seo":{"title":"Retrieve event listing","description":"Retrieve the registration details of the requested event"}},"httpPath":"/events/{event}"},{"label":"List event tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-listings/list_event_tiers","routeSlug":"/openapi/event-listings/list_event_tiers","metadata":{"seo":{"title":"List event tiers","description":"Retrieve a list of all ticket tiers associated with the specified event."}},"httpPath":"/events/{event}/tiers"}]},{"type":"group","label":"Sales Reporting","link":"/openapi/sales-reporting","routeSlug":"/openapi/sales-reporting","items":[{"label":"List host sales","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sales-reporting/list_host_sales","routeSlug":"/openapi/sales-reporting/list_host_sales","metadata":{"seo":{"title":"List host sales","description":"Retrieve a list of all recorded sales for the specified host."}},"httpPath":"/hosts/{host}/sales"},{"label":"Retrieve host statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sales-reporting/retrieve_host_statistics","routeSlug":"/openapi/sales-reporting/retrieve_host_statistics","metadata":{"seo":{"title":"Retrieve host statistics","description":"Retrieve aggregated statistics for a host including total revenue and tickets sold."}},"httpPath":"/hosts/{host}/statistics"},{"label":"List event sales","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sales-reporting/list_event_sales","routeSlug":"/openapi/sales-reporting/list_event_sales","metadata":{"seo":{"title":"List event sales","description":"Retrieve a list of all recorded sales for the specified event."}},"httpPath":"/hosts/{host}/events/{event}/sales"},{"label":"Retrieve event statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sales-reporting/retrieve_event_statistics","routeSlug":"/openapi/sales-reporting/retrieve_event_statistics","metadata":{"seo":{"title":"Retrieve event statistics","description":"Retrieve aggregated statistics for an event including total revenue and tickets sold."}},"httpPath":"/hosts/{host}/events/{event}/statistics"}]},{"type":"group","label":"Event Admissions","link":"/openapi/event-admissions","routeSlug":"/openapi/event-admissions","items":[{"label":"Issue admission tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/manage_admission_tokens","routeSlug":"/openapi/event-admissions/manage_admission_tokens","metadata":{"seo":{"title":"Issue admission tokens","description":"Create tokens that authorise event staff to grant admission to the event. Tokens allow event staff to redeem tickets and admit patrons to one or more event sections. Each event has a global token that allows redemption of tickets for all sections. Additional tokens can be created, as needed, and should be issued to event staff on a one-to-one basis."}},"httpPath":"/events/{event}/tokens"},{"label":"List admission tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/list_event_tokens","routeSlug":"/openapi/event-admissions/list_event_tokens","metadata":{"seo":{"title":"List admission tokens","description":"Retrieve a list of tokens permitted to redeem tickets issued for this event."}},"httpPath":"/events/{event}/tokens"},{"label":"Retrieve admission token details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/retrieve_admission_token","routeSlug":"/openapi/event-admissions/retrieve_admission_token","metadata":{"seo":{"title":"Retrieve admission token details","description":"Retrieve the details of the specified admission token."}},"httpPath":"/events/{event}/tokens/{token}"},{"label":"Modify admission token sections","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/update_admission_token","routeSlug":"/openapi/event-admissions/update_admission_token","metadata":{"seo":{"title":"Modify admission token sections","description":"Update the event sections that the admission token can be used to grant entry to"}},"httpPath":"/events/{event}/tokens/{token}"},{"label":"Invalidate an admission token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/invalidate_admission_token","routeSlug":"/openapi/event-admissions/invalidate_admission_token","metadata":{"seo":{"title":"Invalidate an admission token","description":"Invalidate an admission token and remove it from the event. Invalidated tokens can no longer be used by event staff to redeem tickets and grant admission."}},"httpPath":"/events/{event}/tokens/{token}"},{"label":"Retrieve valid event tickets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/list_event_tickets","routeSlug":"/openapi/event-admissions/list_event_tickets","metadata":{"seo":{"title":"Retrieve valid event tickets","description":"Retrieve a detailed list of valid event tickets issued for sections that the authenticated redeemer is authorised to admit patrons to."}},"httpPath":"/events/{event}/tickets"},{"label":"Admit event patrons","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/admit_event_patrons","routeSlug":"/openapi/event-admissions/admit_event_patrons","metadata":{"seo":{"title":"Admit event patrons","description":"Attempt to admit one or more patrons to an event based on their ticket serial numbers. The endpoint accepts a list containing the serials of tickets to be redeemed. The system will admit any serials that are currently valid for the event sections that the redeemer is authorised to admit to, and return a list of those that were successfully redeemed."}},"httpPath":"/events/{event}/admissions"},{"label":"List event admissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/list_event_admissions","routeSlug":"/openapi/event-admissions/list_event_admissions","metadata":{"seo":{"title":"List event admissions","description":"Retrieve a list of admissions to the event sections that the authenticated redeemer has access to."}},"httpPath":"/events/{event}/admissions"}]},{"type":"separator","label":"Purchasing Tickets"},{"type":"group","label":"Ordering Tickets","link":"/openapi/ordering-tickets","routeSlug":"/openapi/ordering-tickets","items":[{"label":"List customer orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/list_customer_orders","routeSlug":"/openapi/ordering-tickets/list_customer_orders","metadata":{"seo":{"title":"List customer orders","description":"List customer orders matching the specified search criteria"}},"httpPath":"/accounts/{number}/orders"},{"label":"Place a new order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/place_order","routeSlug":"/openapi/ordering-tickets/place_order","metadata":{"seo":{"title":"Place a new order","description":"Place a new order for one or more tickets. A single order can include multipleticket types of a single event, or from multiple events. When a new order is createdtickets are reserved for a fixed period of time until the order is settled, cancelledor times out."}},"httpPath":"/accounts/{number}/orders"},{"label":"Retrieve order details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/retrieve_order","routeSlug":"/openapi/ordering-tickets/retrieve_order","metadata":{"seo":{"title":"Retrieve order details","description":"Retrieve the details of the requested order"}},"httpPath":"/accounts/{number}/orders/{order}"},{"label":"Cancel an order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/cancel_order","routeSlug":"/openapi/ordering-tickets/cancel_order","metadata":{"seo":{"title":"Cancel an order","description":"Cancel an existing order. Any reserved tickets are immediately released. An order can only be cancelled if it has not already been settled or timed out."}},"httpPath":"/accounts/{number}/orders/{order}"},{"label":"Attempt payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/settle_order","routeSlug":"/openapi/ordering-tickets/settle_order","metadata":{"seo":{"title":"Attempt payment","description":"Attempt to settle a pending order by credit card payment. Payment can only be attemptedonce an order has been placed, but before it has timed out or been cancelled. Payment canno longer be attempted once an order has been fulfilled, refunded or cancelled."}},"httpPath":"/accounts/{number}/orders/{order}/payments"}]},{"type":"separator","label":"Managing Tickets"},{"type":"group","label":"Ticket Transfers","link":"/openapi/ticket-transfers","routeSlug":"/openapi/ticket-transfers","items":[{"label":"Initiating a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ticket-transfers/initiate_transfer","routeSlug":"/openapi/ticket-transfers/initiate_transfer","metadata":{"seo":{"title":"Initiating a transfer","description":"Initiate a transfer of one or more tickets from the requesting user to another TickeTing user. Initiating a transfer, does not automatically move tickets between accounts, but instead sends a transfer request. This request must first be claimed at which time the tickets themselves are transferred. If the transfer request is cancelled or rejected, no tickets change hands."}},"httpPath":"/transfers"},{"label":"Retrieve transfer details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ticket-transfers/retrieve_transfer","routeSlug":"/openapi/ticket-transfers/retrieve_transfer","metadata":{"seo":{"title":"Retrieve transfer details","description":"Retrieve the details of the requested transfer"}},"httpPath":"/transfers/{transfer}"},{"label":"Cancel a transfer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ticket-transfers/cancel_transfer","routeSlug":"/openapi/ticket-transfers/cancel_transfer","metadata":{"seo":{"title":"Cancel a transfer","description":"Cancel a pending transfer. A transfer can be cancelled by either its sender or its recipient before it is claimed. Any pending tickets attached to the transfer are immediately released. A transfer can only be cancelled if it has not yet been claimed, or previously cancelled."}},"httpPath":"/transfers/{transfer}"},{"label":"Claim a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ticket-transfers/claim_transfer","routeSlug":"/openapi/ticket-transfers/claim_transfer","metadata":{"seo":{"title":"Claim a transfer","description":"Claim a pending transfer. Once claimed, any tickets attached to the transfer are moved from the sender's account to the recipient's and returned to a usable state. Only a transfer's recipient can claim a transfer, and a transfer can no longer be claimed once it has been cancelled or claimed previously."}},"httpPath":"/transfers/{transfer}/claims"}]},{"type":"separator","label":"System Administration"},{"type":"group","label":"Region Management","link":"/openapi/region-management","routeSlug":"/openapi/region-management","items":[{"label":"List supported regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/list_regions","routeSlug":"/openapi/region-management/list_regions","metadata":{"seo":{"title":"List supported regions","description":"Retrieve a list of supported regions where events can be staged."}},"httpPath":"/regions"},{"label":"Add a supported region","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/add_region","routeSlug":"/openapi/region-management/add_region","metadata":{"seo":{"title":"Add a supported region","description":"Add a supported region to the TickeTing system. Any venue created needs to reference the region in which it is located. Events staged at this venue will be grouped within the related region, and are displayed to users based on their regional preference."}},"httpPath":"/regions"},{"label":"Retrieve region details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/retrieve_region","routeSlug":"/openapi/region-management/retrieve_region","metadata":{"seo":{"title":"Retrieve region details","description":"Retrieve the details of the specified region."}},"httpPath":"/regions/{region}"},{"label":"Modify region details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/update_region","routeSlug":"/openapi/region-management/update_region","metadata":{"seo":{"title":"Modify region details","description":"Update the details of the specified region"}},"httpPath":"/regions/{region}"},{"label":"Remove a supported region","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/remove_region","routeSlug":"/openapi/region-management/remove_region","metadata":{"seo":{"title":"Remove a supported region","description":"Completely remove a supported region from the system. A region can only be deleted if it has no venues associated to it."}},"httpPath":"/regions/{region}"}]},{"type":"group","label":"Venue Management","link":"/openapi/venue-management","routeSlug":"/openapi/venue-management","items":[{"label":"List event venues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/list_venues","routeSlug":"/openapi/venue-management/list_venues","metadata":{"seo":{"title":"List event venues","description":"Retrieve a list of approved venues at which events can be hosted."}},"httpPath":"/venues"},{"label":"Create an event venue","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/create_venue","routeSlug":"/openapi/venue-management/create_venue","metadata":{"seo":{"title":"Create an event venue","description":"Create an approved venue that can stage events. Once created, the venue can be selected as hosting new events added to the system."}},"httpPath":"/venues"},{"label":"Retrieve event venue details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/retrieve_venue","routeSlug":"/openapi/venue-management/retrieve_venue","metadata":{"seo":{"title":"Retrieve event venue details","description":"Retrieve the details of the specified event venue."}},"httpPath":"/venues/{venue}"},{"label":"Modify event venue details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/update_venue","routeSlug":"/openapi/venue-management/update_venue","metadata":{"seo":{"title":"Modify event venue details","description":"Update the details of the specified event venue"}},"httpPath":"/venues/{venue}"},{"label":"Remove an event venue","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/delete_venue","routeSlug":"/openapi/venue-management/delete_venue","metadata":{"seo":{"title":"Remove an event venue","description":"Completely remove an event venue from the system. A venue can only be deleted if no events are or have been staged there."}},"httpPath":"/venues/{venue}"}]},{"type":"group","label":"Category Management","link":"/openapi/category-management","routeSlug":"/openapi/category-management","items":[{"label":"List event categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/list_categories","routeSlug":"/openapi/category-management/list_categories","metadata":{"seo":{"title":"List event categories","description":"Retrieve a list of event categories under which events can be classified."}},"httpPath":"/categories"},{"label":"Create an event category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/create_category","routeSlug":"/openapi/category-management/create_category","metadata":{"seo":{"title":"Create an event category","description":"Create an event category (and its associated subcategories). Once created, the category (and one of its subcategories) can be used to classify events."}},"httpPath":"/categories"},{"label":"Retrieve category details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/retrieve_category","routeSlug":"/openapi/category-management/retrieve_category","metadata":{"seo":{"title":"Retrieve category details","description":"Retrieve the details of the specified event category."}},"httpPath":"/categories/{category}"},{"label":"Modify category details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/update_category","routeSlug":"/openapi/category-management/update_category","metadata":{"seo":{"title":"Modify category details","description":"Update the details of the specified event category"}},"httpPath":"/categories/{category}"},{"label":"Remove a category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/delete_category","routeSlug":"/openapi/category-management/delete_category","metadata":{"seo":{"title":"Remove a category","description":"Completely remove an event category from the system. A category can only be deleted if it is not associated with any events."}},"httpPath":"/categories/{category}"}]},{"type":"group","label":"Reviewing Content","link":"/openapi/reviewing-content","routeSlug":"/openapi/reviewing-content","items":[{"label":"List submissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reviewing-content/list_submissions","routeSlug":"/openapi/reviewing-content/list_submissions","metadata":{"seo":{"title":"List submissions","description":"Retrieve a list of content submitted for administrative review and publising approval."}},"httpPath":"/submissions"},{"label":"Retrieve submission details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reviewing-content/retrieve_submission","routeSlug":"/openapi/reviewing-content/retrieve_submission","metadata":{"seo":{"title":"Retrieve submission details","description":"Retrieve the details of the specified content submission"}},"httpPath":"/submissions/{submission}"},{"label":"Retrieve submission decision","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reviewing-content/retrieve_submission_decision","routeSlug":"/openapi/reviewing-content/retrieve_submission_decision","metadata":{"seo":{"title":"Retrieve submission decision","description":"Retrieve details of the decision taken on a submission, if one exists"}},"httpPath":"/submissions/{submission}/decision"},{"label":"Decide on a submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reviewing-content/take_submission_decision","routeSlug":"/openapi/reviewing-content/take_submission_decision","metadata":{"seo":{"title":"Decide on a submission","description":"Take a decision (approve/reject) on the content submission"}},"httpPath":"/submissions/{submission}/decision"}]},{"type":"group","label":"Default Values","link":"/openapi/default-values","routeSlug":"/openapi/default-values","items":[{"label":"Retrieve a list of countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/default-values/retrieve_countries","routeSlug":"/openapi/default-values/retrieve_countries","metadata":{"seo":{"title":"Retrieve a list of countries","description":"Retrieve a list of country names to be used in association with user accounts, events, hosts, etc."}},"httpPath":"/countries"}]}]}