API REST: Getting your Events

Events can be a show, ride, or performance that you have created for your account. They have a starting date and time, title, description, ticket products, etc.

Event Instance Resource

Resource Properties

Property Description
Active Date The date and time the event becomes available for publishing to the website.
Event Applications A collection of the external application keys relating to the event. This is where you would find the Facebook event id.
Event Date The starting time of the event.
Floor Plan ID The ID of the Floor Plan used for the event. You would use this ID to get the section and images of the FloorPlan by making a request.
Headline A short description of the event. It is limited to 1024 characters.
ID This is unique identifier for the event.
Is Sold Out Indication of whether tickets are still available to the event.
Media A collection images, videos, and sounds assigned to the event.
Sold The number of tickets sold for the event.
StatusID A string representation of the status of the event. May be Pending, Active, or Canceled.
Ticket Capacity The total number of seats/tickets allocated for the event.
Title A very short description of the event. It is limited to 255 characters. If this event will be synchronized to Facebook, it should be limited to less than 75 characters.
Venue Information about the venue for the event. Contains properties for name, address, time zone, phone number, etc.

Event Category Values

Resource URI/{AccountKey}/Events/{EventID}?type={ObjectType}Optional ParametersYou may specify one or more of the following parameters to filter the amount of data returned from the API.HTTP GETInstance GetWhen used with the EventID parameter, returns the single event resource identified by EventID.Example curl http://api.ticketbiscuit.com/ticketbiscuit/events/43267 { “Venue”: { “ID”: 1184, “Name”: “Wallace Hall Fine Arts Center”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Central Standard Time”, “StreetAddress1”: “1001 George Wallace Drive”, “StreetAddress2”: “”, “City”: “Gadsden”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “35902” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: true, “StartingValue”: null, “EndingValue”: “2013-04-08T16:15:00Z”, “From”: null, “To”: “2013-04-08T16:15:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “Passbook.Enabled”: “true”, “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “True” }, “Owner”: { “Name”: “TicketBiscuit”, “Key”: “TicketBiscuit”, “ID”: 1, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-04-08T16:15:00Z”, “EventDateOverride”: “Always On”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 8, “Key”: null }], “FloorPlanID”: 288, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “”, “DoorsOpenText”: null, “ID”: 43267, “Media”: [{ “ID”: 348861, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/34886”, “SecureSourceUri”: null, “LegacyID”: 34886, “SourceType”: 1 }], “MinimumAge”: 0, “Sold”: 19, “TicketCapacity”: 1189, “WebProductTicketCapacity”: 1189, “Title”: “Trombone Unleashed”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2012-12-04T16:55:00Z”, “DoorsOpen”: null, “StatusID”: 2 } Upcoming ListWith no optional parameters presented, returns a list of upcoming events for AccountKey.Example curl http://api.ticketbiscuit.com/ticketbiscuit/events [{ “Venue”: { “ID”: 3, “Name”: “The WorkPlay SoundStage”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Central Standard Time”, “StreetAddress1”: “500 23rd St. South”, “StreetAddress2”: “”, “City”: “Birmingham”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “35233” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: false, “StartingValue”: “2013-05-25T18:05:00Z”, “EndingValue”: “2013-06-04T21:05:00Z”, “From”: “2013-05-25T18:05:00Z”, “To”: “2013-06-04T21:05:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “Passbook.Enabled”: “true”, “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “false” }, “Owner”: { “Name”: “The WorkPlay Theatre”, “Key”: “WorkPlay”, “ID”: 2, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-06-04T18:05:00Z”, “EventDateOverride”: “”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 8, “Key”: null }], “FloorPlanID”: 0, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “A truly awe inspiring outpouring of emotion.”, “DoorsOpenText”: null, “ID”: 42683, “Media”: [{ “ID”: 348781, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/34878”, “SecureSourceUri”: null, “LegacyID”: 34878, “SourceType”: 1 }], “MinimumAge”: 0, “Sold”: 11, “TicketCapacity”: 410, “WebProductTicketCapacity”: 410, “Title”: “Ticket Sales Begin On Specific Date and Time”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2012-07-03T18:16:00Z”, “DoorsOpen”: null, “StatusID”: 2 }, { “Venue”: { “ID”: 1361, “Name”: “TicketBiscuit DST Venue”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Hawaiian Standard Time”, “StreetAddress1”: “300 Riverchase Parkway”, “StreetAddress2”: “”, “City”: “Birmingham”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “35244” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: true, “StartingValue”: null, “EndingValue”: “2013-05-24T18:35:00Z”, “From”: null, “To”: “2013-05-24T18:35:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “Passbook.Enabled”: “false”, “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “false” }, “Owner”: { “Name”: “TicketBiscuit”, “Key”: “TicketBiscuit”, “ID”: 1, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-05-24T18:35:00Z”, “EventDateOverride”: “”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 8, “Key”: null }, { “ApplicationType”: 2, “Key”: “423762787671782” }], “FloorPlanID”: 0, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “We’ve waited so long”, “DoorsOpenText”: null, “ID”: 42986, “Media”: [{ “ID”: 353631, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/35363”, “SecureSourceUri”: null, “LegacyID”: 35363, “SourceType”: 1 }], “MinimumAge”: 0, “Sold”: 1, “TicketCapacity”: 2, “WebProductTicketCapacity”: 2, “Title”: “(I’ve Got) Two Tickets to Paradise”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2012-09-28T16:42:00Z”, “DoorsOpen”: null, “StatusID”: 2 }, { “Venue”: { “ID”: 1184, “Name”: “Wallace Hall Fine Arts Center”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Central Standard Time”, “StreetAddress1”: “1001 George Wallace Drive”, “StreetAddress2”: “”, “City”: “Gadsden”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “35902” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: true, “StartingValue”: null, “EndingValue”: “2013-04-10T01:00:00Z”, “From”: null, “To”: “2013-04-10T01:00:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “Passbook.Enabled”: “false”, “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “True” }, “Owner”: { “Name”: “TicketBiscuit”, “Key”: “TicketBiscuit”, “ID”: 1, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-04-10T01:00:00Z”, “EventDateOverride”: “test text”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 8, “Key”: null }], “FloorPlanID”: 288, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “”, “DoorsOpenText”: null, “ID”: 43268, “Media”: [{ “ID”: 348861, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/34886”, “SecureSourceUri”: null, “LegacyID”: 34886, “SourceType”: 1 }], “MinimumAge”: 0, “Sold”: 0, “TicketCapacity”: 364, “WebProductTicketCapacity”: 364, “Title”: “Trombone Unleashed – Friends and Family”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2012-12-04T17:04:00Z”, “DoorsOpen”: null, “StatusID”: 2 }] HTTP POSTPosting an EventSearchRequest to the Event Resource Uri will enable callers to perform finer searches. With the EventSearchRequest requests can be filtered to only events at a specific venue, events featuring one or more artists, etc.ExampleSearch for all events for Account 1 occurring between April 4, 2013 3:00 PM to April 15, 2013 3:00 PM. curl http://api.branch.corp.ticketbiscuit.com/TicketBiscuit/events -H “Content-Type: application/json” -H “Accept: application/json” -X POST -d ‘{ “FavoritesOnly”: false, “IncludeCanceled”: false, “MaximumCount”: 5, “EventDate”: { “From”: “/Date(1365105600105)/”, “To”: “/Date(1366056000497)/” } }’ [{ “Venue”: { “ID”: 1184, “Name”: “Wallace Hall Fine Arts Center”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Central Standard Time”, “StreetAddress1”: “1001 George Wallace Drive”, “StreetAddress2”: “”, “City”: “Gadsden”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “35902” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: true, “StartingValue”: null, “EndingValue”: “2013-04-08T16:15:00Z”, “From”: null, “To”: “2013-04-08T16:15:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “True”, “Passbook.Enabled”: “true” }, “Owner”: { “Name”: “TicketBiscuit”, “Key”: “TicketBiscuit”, “ID”: 1, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-04-08T16:15:00Z”, “EventDateOverride”: “Always On”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 8, “Key”: null }], “FloorPlanID”: 288, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “”, “DoorsOpenText”: null, “ID”: 43267, “Media”: [{ “ID”: 348861, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/34886”, “SecureSourceUri”: null, “LegacyID”: 34886, “SourceType”: 1 }], “MinimumAge”: 0, “Sold”: 19, “TicketCapacity”: 1189, “WebProductTicketCapacity”: 1189, “Title”: “Trombone Unleashed”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2012-12-04T16:55:00Z”, “DoorsOpen”: null, “StatusID”: 2 }, { “Venue”: { “ID”: 1184, “Name”: “Wallace Hall Fine Arts Center”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Central Standard Time”, “StreetAddress1”: “1001 George Wallace Drive”, “StreetAddress2”: “”, “City”: “Gadsden”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “35902” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: true, “StartingValue”: null, “EndingValue”: “2013-04-10T01:00:00Z”, “From”: null, “To”: “2013-04-10T01:00:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “True”, “Passbook.Enabled”: “false” }, “Owner”: { “Name”: “TicketBiscuit”, “Key”: “TicketBiscuit”, “ID”: 1, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-04-10T01:00:00Z”, “EventDateOverride”: “test text”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 8, “Key”: null }], “FloorPlanID”: 288, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “”, “DoorsOpenText”: null, “ID”: 43268, “Media”: [{ “ID”: 348861, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/34886”, “SecureSourceUri”: null, “LegacyID”: 34886, “SourceType”: 1 }], “MinimumAge”: 0, “Sold”: 0, “TicketCapacity”: 364, “WebProductTicketCapacity”: 364, “Title”: “Trombone Unleashed – Friends and Family”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2012-12-04T17:04:00Z”, “DoorsOpen”: null, “StatusID”: 2 }, { “Venue”: { “ID”: 1, “Name”: “TB Demo Venue”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Central Standard Time”, “StreetAddress1”: “621 Oak Glen Dr”, “StreetAddress2”: “”, “City”: “Hoover”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “35244” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: true, “StartingValue”: null, “EndingValue”: “2013-04-07T03:00:00Z”, “From”: null, “To”: “2013-04-07T03:00:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “false”, “Passbook.Enabled”: “true” }, “Owner”: { “Name”: “TicketBiscuit”, “Key”: “TicketBiscuit”, “ID”: 1, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-04-07T03:00:00Z”, “EventDateOverride”: “”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 2, “Key”: “438753229540470” }], “FloorPlanID”: 0, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “April 6 event missing from end of March 2013 calendar page.”, “DoorsOpenText”: null, “ID”: 43696, “Media”: [{ “ID”: 360261, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/36026”, “SecureSourceUri”: null, “LegacyID”: 36026, “SourceType”: 1 }, { “ID”: 189241, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/18924”, “SecureSourceUri”: null, “LegacyID”: 18924, “SourceType”: 1 }], “MinimumAge”: 0, “Sold”: 4, “TicketCapacity”: 109, “WebProductTicketCapacity”: 109, “Title”: “GEM:5054”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2013-03-14T20:26:00Z”, “DoorsOpen”: null, “StatusID”: 2 }, { “Venue”: { “ID”: 1184, “Name”: “Wallace Hall Fine Arts Center”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Central Standard Time”, “StreetAddress1”: “1001 George Wallace Drive”, “StreetAddress2”: “”, “City”: “Gadsden”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “35902” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: true, “StartingValue”: null, “EndingValue”: “2013-04-08T16:15:00Z”, “From”: null, “To”: “2013-04-08T16:15:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “False”, “Passbook.Enabled”: “true” }, “Owner”: { “Name”: “TicketBiscuit”, “Key”: “TicketBiscuit”, “ID”: 1, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-04-08T16:15:00Z”, “EventDateOverride”: “Always On”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 8, “Key”: null }], “FloorPlanID”: 288, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “”, “DoorsOpenText”: null, “ID”: 43796, “Media”: [{ “ID”: 348861, “Caption”: “”, “SourceUri”: “http://test.static.ticketbiscuit.com/images/34886”, “SecureSourceUri”: null, “LegacyID”: 34886, “SourceType”: 1 }], “MinimumAge”: 0, “Sold”: 0, “TicketCapacity”: 813, “WebProductTicketCapacity”: 813, “Title”: “Release Tickets”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2013-04-01T18:18:00Z”, “DoorsOpen”: null, “StatusID”: 2 }, { “Venue”: { “ID”: 164, “Name”: “Alabama State University”, “WebSite”: null, “PrimaryLocation”: { “Longitude”: null, “Latitude”: null, “Altitude”: null, “TimeZoneID”: “Central Standard Time”, “StreetAddress1”: “915 S. Jackson Street”, “StreetAddress2”: “”, “City”: “Montgomery”, “StateOrProvince”: “AL”, “CountryOrRegion”: “US”, “PostalCode”: “36104” }, “PrimaryTelephoneNumber”: null }, “AuthorizedAccounts”: [], “AvailableForWebSales”: { “IsCurrentlyActive”: true, “StartingValue”: null, “EndingValue”: “2013-04-15T19:00:00Z”, “From”: null, “To”: “2013-04-15T19:00:00Z” }, “AlternateTicketingUrl”: “”, “Category”: 0, “Context”: { “Settings”: { “DoorsOpenLabelTextDefault”: “Doors open”, “EventDateOverride.Enabled”: “false”, “Passbook.Enabled”: “true” }, “Owner”: { “Name”: “TicketBiscuit”, “Key”: “TicketBiscuit”, “ID”: 1, “EmailAddress”: null }, “IsFavorite”: true }, “EventDate”: “2013-04-15T19:00:00Z”, “EventDateOverride”: “”, “ExternalLinks”: { }, “EventApplications”: [{ “ApplicationType”: 8, “Key”: null }, { “ApplicationType”: 2, “Key”: “359170524202725” }], “FloorPlanID”: 128, “Genres”: [], “IsPrivate”: false, “IsSoldOut”: false, “IsSoldOutOverride”: false, “HasWebProductsForSale”: true, “Headline”: “”, “DoorsOpenText”: null, “ID”: 43808, “Media”: [], “MinimumAge”: 0, “Sold”: 1, “TicketCapacity”: 204, “WebProductTicketCapacity”: 204, “Title”: “Event A”, “CultureCode”: “en-US”, “UICultureCode”: “en-US”, “ActiveDate”: “2013-04-04T17:00:00Z”, “DoorsOpen”: null, “StatusID”: 2 }] HTTP PUTNot SupportedHTTP DELETENot Supported

Category Description
General 0
Music 1
Film 2
Theatre 3
Sports 4
Conference 5
Exhibit 6
Festival 7
Fund Raiser 8
Dance 9
Live Comedy 10
Train Ride 11
Trolley Ride 12
Parameter Description
EventID The numeric id of the event. If no EventID is specified, a list of upcoming events is returned; events that happened 8 hours from the request and 90 days into the future.
ObjectType A string representing the amount of detail returned about the event. May be eventlistitem, event, or ticketedevent. If no type is provided, the data returned will be of type EventListItem. You or your application will require additional permission if the type provided is TicketedEvent. Either GET or POST.
Property Description
Event Category An array of string values to limits the search results. Possible values are documented in the Event Category Values above.
Favorites Only A boolean value when set to true will only return the events marked as being Spotlight in the options tab of the event wizard. The default value is to return all events.
Include Canceled A boolean value what set to true will also include canceled events in the search results. The default value is to exclude canceled events.
Maximum Count A numeric value to limit the number of events returned to the caller. The default value is set to 100.
Attractions TBD
Event Date A javascript object that contains both a To and From property. These properties are string representations of
a date. They can be formatted in one of the three following formats:
ISO 8601,
Javascript Date Object, or
Microsoft's Json Format
Location TBD
Ticketing TBD
Venue TBD