Get Ticket Events (BETA)

Get a list of ticket events with information about a ticket event. The most current ticket events are listed. The maximum number of ticket events per page is 100. If the next_url field is present in the result and not null, use that URL to get the next page. The ticket group name may be null if the ticket event is not an advanced event.

By default, this API does not return timed entry events. To enable timed entry events, set supports_timed_entry_events to T. The following field is not returned for timed entry events: pricing_levels.


Event Types

If the event_type field is used, ticket events with the specific event type will be searched. See the following for a definition of event types:

Event Types
  • general: General
  • air_show: Air Show
  • appearance_or_signing: Appearance or signing
  • beer_event: Beer event
  • camp_trip_or_retreat: Camp, trip, or retreat
  • class_training_or_workshop: Class, training, or workshop
  • concert_or_music_festival: Concert or Music Festival
  • conference: Conference
  • corn_maze: Corn Maze
  • dinner_or_gala: Dinner or gala
  • festival: Festival
  • food_festival: Food Festival
  • game_or_competition: Game or competition
  • golf_outing: Golf outing
  • halloween_event: Halloween Event
  • hay_ride: Hay Ride
  • lights_show: Lights Show
  • meeting_or_networking_event: Meeting or networking event
  • other: Other
  • party_or_social_gathering: Party or social gathering
  • performance: Performance
  • screening: Screening
  • seminar_or_talk: Seminar or talk
  • tour: Tour
  • tournament: Tournament
  • volunteer: Volunteer
  • wine_event: Wine Event


Response Format

{
	"next_url": "https:\/\/example.com/Rest/v2/tickets/get-ticket-events.json?...",
	"ticket_events" : [
		"ticket_event_id": 123,
		"ticket_event_name": "Example Ticketable Event",
		"timezone": "America\/New_York",
		"event_type": "Game or competition",
		"homepage_url": "https:\/\/runsignup.com\/TicketEvent\/ExampleTicketableEvent",
		"start_ts": 1546322400,
		"end_ts": 1893905999,
		"created_ts": 1433522400,
		"modified_ts": 1546321300,
		"location_description": "The Office",
		"address1": "300 Mill St.",
		"address2": "Suite 200",
		"city": "Moorestown",
		"state": "NJ",
		"zipcode": "08057",
		"countrycode": "US",
		"contact_email": "example@example.com",
		"is_advanced_ticket_event": "T",
		"is_timed_entry_ticket_event": "F",
		"logo_url": "https://example.com/example.png",
		"ticket_groups": [
			{
				"ticket_group_id": 1,
				"start_ts": 1546322400,
				"end_ts": 1893905999,
				"ticket_group_name": "Spaghetti Dinner",
				"ticket_group_levels": [
					{
						"ticket_level_id": 1,
						"ticket_level_name": "Meat Sauce"
						"pricing_levels": []
					},
					{
						"ticket_level_id": 11,
						"ticket_level_name": "Marinara"
						"pricing_levels": [
							{
								"min_total_number_tickets": 1,
								"max_total_number_tickets": 100,
								"ticket_cost_in_cents": 2500,
								"pricing_start_ts": 1632456000,
								"pricing_end_ts": 1641013199
							},
							{
								"min_total_number_tickets": 1,
								"max_total_number_tickets": 65,
								"ticket_cost_in_cents": 2500,
								"pricing_start_ts": 1641013199,
								"pricing_end_ts": 1741013199
							}
						]
					}
				]
			},
			{
				"ticket_group_id": 2,
				"start_ts": 1546322400,
				"end_ts": 1893905999,
				"ticket_group_name": "Golf Outing",
				"ticket_group_levels": [
					{
						"ticket_level_id": 4,
						"ticket_level_name": "Ticket"
						"pricing_levels": [
							{
								"min_total_number_tickets": 1,
								"max_total_number_tickets": 200,
								"ticket_cost_in_cents": 2500,
								"pricing_start_ts": 1632456000,
								"pricing_end_ts": 1641013199
							}
						]
					}
				]
			}
		],
		"description_html": "

This is a description. This is only included if include_html_description is enabled.

", "description_text": "This is a description. This is only included if include_text_description is enabled." ] }

URL

https://www.givesignup.org/rest/v2/tickets/get-ticket-events.json

HTTP Method

GET

Parameters

Parameter HTTP Method Default Description Datatype
supports_timed_entry_events GET F Are timed entry events supported? bool
num GET 100 Number of results per page (max 500). uint
min_ticket_event_id GET Get ticket events with ID of at least given ID. uint
max_ticket_event_id GET Get ticket events with ID no larger than given ID. uint
created_on_or_after_ts GET Get ticket events created since a given time. uint
created_on_or_before_ts GET Get ticket events created on or before a given time. uint
modified_on_or_after_ts GET Get ticket events modified since a given time. uint
modified_on_or_before_ts GET Get ticket events modified on or before a given time. uint
city GET Search by city. string
state GET Search by state. E.g. NJ string
country GET Search by country. E.g. US country
zipcode GET Search by zipcode. string
radius GET Search for events within radius miles from zipcode (US Only; Max 250 miles). string
event_type GET Search by event type. string
include_html_description GET F Include event description as HTML. bool
include_text_description GET F Include event description as text. bool
include_pricing GET Should pricing be included? bool

If you continue to use this site, you consent to use all cookies. We use cookies to offer you a better browsing experience. Read how we use cookies and how you can control them by visiting our Privacy Policy.

If you continue to use this site, you consent to use all cookies.