Tickitto Docs

Search for Events

The search endpoint is typically the first endpoint called to initiate an interaction with the Tickitto API and retrieves events within the date ranges specified.

The Tickitto inventory is availability aware. Therefore, at the time of performing a search query, all events returned will have availability instances for the date ranges specified.

If an event does not have any availability within the specified search date, it will not be returned in searches.

The search endpoint enables filtration for different event categories, cities, or countries to create a powerful contextual search experience.

Endpoint

POST tickitto.tech/api/events

Query Parameters

t1 date *required The 'from date' in ISO 8601 format. Ex: 2020-07-11


t2 date *required The 'to date' in ISO 8601 format. Ex: 2020-07-25


categories [string] Tickitto's classification of the event type. An event can have more than one category. Ex: museum , child-friendly , football


city string The city where the event takes place. Ex: London


Country string The country where the event takes place. Ex: United Kingdom


country_code string The country code in ISO 3166-2 format. Ex: GB


Request

{
"t1": "2020-07-11",
"t2": "2020-07-25",
"categories": [],
"city": [],
"country": [],
"country_code": []
}

Response

[
{
"event_id": "string",
"title": "string",
"from_price": 0,
"currency": "string",
"description": "string",
"images": [],
"categories": [],
"admission_type": "string",
"entry_notes": [],
"duration": "",
"venue_location": []
"city": "string",
"country": "string",
"country_code": "string",
"cancellation_allowed": false,
"cancellation_policy": "",
"addon_required": false,
"addons": [],
"pickup_required": false,
"pickup_points": [],
}
]

Attributes

event_id string Tickitto's unique identifier for an event Ex: T008


title string The title of the event. Ex: Moulin Rouge


from_price number The starting price of a ticket for an event. Usually, this is the lowest price available for the specified search dates. Ex: 45


currency string Currency identifier for the price of a ticket in ISO 4217 format. All ticket prices are displayed in Tickitto's base currency; GBP Ex: GBP


description string The long description of the event.


images [string] URL Links for the event media.


categories [string] Tickitto's classification of the event type. Ex: museum , child-friendly , football


admission_type string Tickitto's classification of the event's admission type. Ex: open_entry , timed_entry , date_entry, slot_entry


entry_notes [string] Additional details from the event supplier on the admission process. Ex: "Please arrive 30 minutes before the start time."


venue_location object Location details of the venue where the event occurs. This includes:

  • venue_name string
  • venue_address string
  • latitude string
  • longitude string

city string City where the event takes place Ex: London


country string Country where the event takes place Ex: United Kingdom


country_code string The country code in ISO 3166-2 format. Ex: GB


cancellation_allowed boolean Whether or not the tickets can be canceled after purchase, depending on the supplier's cancellation policy. Ex: false


cancellation_policy string Details on what the supplier's cancellation policy is for that event. Ex: "Cancellation allowed 48 hours in advance of admission date".


addon_required boolean Depending on the event, the user may be required to make a food selection or any other add ons. For example a dinner cruise will require users to add on what their preferred meal will be. Ex:false


addons [object] A selection of add on options available for the ticket buyer to choose from if addon_required is set to true. Please note that Tickitto's Ticket Selection Widget will display the available add ons for a specific event via the relevant UI. Therefore as a developer, you will not need to orchestrate API calls or design components associated with add ons.


pickup_required boolean Whether or not the attendees of the event will need to be picked up from a list of identified pickup points. For example, a private jeep safari in South Africa where the tour guide and driver would pick up the attendees from a specific point. Ex:true


pickup_points [object] A selection of pickup points available for the ticket buyer to choose from if pickup_required is set to true. Please note that Tickitto's Ticket Selection Widget will display the available pickup options for a specific event via the relevant UI. Therefore as a developer, you will not need to orchestrate API calls or design components associated with pickup points.