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.
To get only ticket events linked to your partner account, set only_partner_events to T.
This requires a partner API key in rsu_api_key and its secret in the X-RSU-API-SECRET header.
Only public ticket events are returned.
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:
{
"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,
"faux_price_in_cents": 3500,
"pricing_start_ts": 1632456000,
"pricing_end_ts": 1641013199
},
{
"min_total_number_tickets": 1,
"max_total_number_tickets": 65,
"ticket_cost_in_cents": 2500,
"faux_price_in_cents": null,
"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,
"faux_price_in_cents": null,
"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."
]
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
rsu_api_reg |
GET | API caller token. If used, you must send the API caller password in an HTTP header named X-RSU-API-REG-SECRET. | string |
|
X-RSU-API-REG-SECRET |
HTTP Header | API caller password. | string |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
supports_timed_entry_events |
GET | F | Are timed entry events supported? | bool |
rsu_api_key |
GET | API key. | string |
|
X-RSU-API-SECRET |
HTTP Header | API secret. | string |
|
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 |
|
only_partner_events |
GET | F | Only get events linked to the partner using the API. Requires a partner API key. | bool |
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 |
{
"openapi": "3.0.3",
"info": {
"title": "Get Ticket Events (BETA)",
"description": "Get ticket events.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://api.runsignup.com/rest",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Ticket Events",
"description": "APIs related to Ticket Events"
}
],
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message"
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": true
}
},
"required": [
"error"
]
},
"BadRequestError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating invalid request parameters or structure"
}
]
},
"UnauthorizedError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating authentication failure"
}
]
},
"ForbiddenError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the authenticated user lacks required permissions"
}
]
},
"NotFoundError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the requested resource does not exist"
}
]
},
"ServerError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating an unexpected server-side issue"
}
]
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "query",
"name": "api_key",
"description": "RunSignup API Key"
},
"apiSecret": {
"type": "apiKey",
"in": "query",
"name": "api_secret",
"description": "RunSignup API Secret"
},
"apiCaller": {
"type": "apiKey",
"in": "query",
"name": "rsu_api_reg",
"description": "API caller token (format: <id>.<token>)"
},
"apiCallerSecret": {
"type": "apiKey",
"in": "header",
"name": "X-RSU-API-REG-SECRET",
"description": "API caller password"
}
}
},
"paths": {
"/v2/tickets/get-ticket-events.json": {
"get": {
"tags": [
"Ticket Events"
],
"summary": "Get Ticket Events (BETA)",
"description": "Get ticket events.",
"operationId": "v2_tickets_get_ticket_events_json",
"parameters": [
{
"name": "rsu_api_reg",
"in": "query",
"description": "API caller token. If used, you must send the API caller password in an HTTP header named X-RSU-API-REG-SECRET.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-REG-SECRET",
"in": "header",
"description": "API caller password.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "supports_timed_entry_events",
"in": "query",
"description": "Are timed entry events supported?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "rsu_api_key",
"in": "query",
"description": "API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-SECRET",
"in": "header",
"description": "API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "num",
"in": "query",
"description": "Number of results per page (max 500).",
"required": false,
"schema": {
"type": "integer",
"default": "100"
}
},
{
"name": "min_ticket_event_id",
"in": "query",
"description": "Get ticket events with ID of at least given ID.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "max_ticket_event_id",
"in": "query",
"description": "Get ticket events with ID no larger than given ID.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "created_on_or_after_ts",
"in": "query",
"description": "Get ticket events created since a given time.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "created_on_or_before_ts",
"in": "query",
"description": "Get ticket events created on or before a given time.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "modified_on_or_after_ts",
"in": "query",
"description": "Get ticket events modified since a given time.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "modified_on_or_before_ts",
"in": "query",
"description": "Get ticket events modified on or before a given time.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "city",
"in": "query",
"description": "Search by city.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "Search by state. E.g. NJ",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "country",
"in": "query",
"description": "Search by country. E.g. US",
"required": false,
"schema": {
"type": "string",
"enum": [
"US",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"XK",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
]
}
},
{
"name": "zipcode",
"in": "query",
"description": "Search by zipcode.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "radius",
"in": "query",
"description": "Search for events within radius miles from zipcode (US Only; Max 250 miles).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event_type",
"in": "query",
"description": "Search by event type.",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "only_partner_events",
"in": "query",
"description": "Only get events linked to the partner using the API. Requires a partner API key.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_html_description",
"in": "query",
"description": "Include event description as HTML.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_text_description",
"in": "query",
"description": "Include event description as text.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_pricing",
"in": "query",
"description": "Should pricing be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": ""
}
}
],
"security": [
{
"apiKey": [],
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerError"
}
}
}
}
},
"x-permissions": [
"affiliates",
"partners",
"race_directors",
"timers"
]
}
}
}
}
Log in and register as an API caller to get the most out of the API documentation.