Accessing and testing the TicketCo Public API

Using our TicketCo Public API enables you to seamlessly integrate your events in other websites, and the data returned by the API can be harnessed to gain insights into your ticket sales and to build databases. This article will cover how to get access to the API token, the different API data sets, and how you can test the API token.

What data can the API provide?

We have 3 main fields of data which the API can collect, and when requesting access to your API token, please let us know which data set you require access to. 

Events

1. The main events API is the most commonly used, and it presents information regarding an organiser's events in the platform. The data provided includes the basic data surrounding time, location (found under Event details) as well as information regarding the ticket types on sale.
2. The event status API will return data on the status of a specific event when you input the API token and event ID.

These fields contain public information, so this API token is generally available for all customers and users on the account upon request.

Item grosses

This returns transactions relating to the organiser or division in question, such as the date of order, event name, event start, item type, purchaser name and email, item price.

This contains more sensitive data, so if you ask for access to this, we may have to verify the request with the primary contact on the account.

Customers

This returns data regarding the customers relating to the organiser in question, including name, email and phone number.

This contains more sensitive data, so if you ask for access to this, we may have to verify the request with the primary contact on the account.

Accessing your TicketCo API key

To get access to your TicketCo API key, please contact us on cs@ticketco.net. You should contact us from the same email address as that which is connected to your TicketCo user, so that we know the request is coming from an approved user. Please note that if we do not recognise your email address, we will likely need to get permission from the primary contact on the account before we can action the request. 

Testing the API token

Once you have received the token from us, you can test it out on our TicketCo Public API page: 

https://apidoc.ticketco.events/

Select the various data fields to expand them, and select Get or Expand Operations to reveal more information.

Input the token under the token field in Parameters, along with any other queries you might want to test. Hit Try it out! to see what the data the API returns.

Note that under the Events API, only 20 events are displayed per page, so you will need to input a page number if you are looking for 20+ events. If you wish to display private events (events with the Make this event private setting activated) you will need to input "true" into the private field.

If you are receiving an error message when testing the API token this could be because:

• There are no events or purchases available for the token (perhaps no events have been published yet).
• The token was inputted correctly, so double check the token you received from TicketCo.
• The data field was not activated when the token was generated e.g. your token is only active for the events operations, meaning it will not return results for customer information or item grosses. In this case, you will need to inform us that you require access to other data sets.

If your API token worked as expected, then you can now employ it as you wish - whether that be in a database, or to integrate events in your webpage! As always, please ensure that you are operating within current rules and regulations when it comes to handling customer data. More information regarding GDPR for event organisers is found on our blog pages.