Get a list of results for all result sets for an event.
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
api_key |
GET | API Key | string |
|
api_secret |
GET | API Secret | string |
|
tmp_key |
GET | Temporary API Key from login API call. This should NOT be used in combination with API Key. | string |
|
tmp_secret |
GET | Temporary API Secret from login API call. This should NOT be used in combination with API Secret. | string |
|
rsu_api_key |
GET | API v2 key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. | string |
|
sp_api_key |
GET | Super partner API key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. | string |
|
X-RSU-API-SECRET |
HTTP Header | API v2 or super partner secret. | string |
|
format |
GET | xml | Format of response. The default if not sent is `xml`, but `json` is preferred. | format |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
race_idRequired |
GET | ID of race. | uint |
|
event_idRequired |
GET | ID of event. | uint |
|
individual_result_set_id |
GET | ID of result set. | uint |
|
include_total_finishers |
F | Indicates whether or not to include total finishers in result set metadata. (Not supported for CSV) | bool |
|
include_split_time_ms |
F | Indicates whether or not to include milliseconds in split times. | bool |
|
modified_after_timestamp |
GET | Get results modified after a given timestamp | unix_timestamp |
|
supports_nb |
GET | F | Does integration support non-binary X gender? | bool |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
page |
GET | 1 | Page number to get. | uint |
results_per_page |
GET | 50 | Number of results per page. | uint |
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
first_name |
Search for results by first name. | string |
||
last_name |
Search for results by last name. | string |
||
gender |
Search for results by gender. | gender |
||
bib_num |
Search for results by bib number. | uint |
||
registration_id |
Search for results by registration ID. | uint |
||
min_place |
Search for results by minimum finishing place. | uint |
||
max_place |
Search for results by maximum finishing place. | uint |
||
min_age |
Search for results by minimum age. | uint |
||
max_age |
Search for results by maximum age. | uint |
||
state |
Search for results by state. | state |
||
country |
Search for results by country. | country |
{
"openapi": "3.0.3",
"info": {
"title": "Get Event Results",
"description": "List all results for all result sets for an event.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://runsignup.com/API",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Results",
"description": "APIs related to Results"
}
],
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message"
}
},
"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"
}
}
},
"paths": {
"/race/:race_id/results/get-results": {
"get": {
"tags": [
"Results"
],
"summary": "Get Event Results",
"description": "List all results for all result sets for an event.",
"operationId": "race_:race_id_results_get_results",
"parameters": [
{
"name": "api_key",
"in": "query",
"description": "API Key",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "api_secret",
"in": "query",
"description": "API Secret",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tmp_key",
"in": "query",
"description": "Temporary API Key from login API call. This should NOT be used in combination with API Key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tmp_secret",
"in": "query",
"description": "Temporary API Secret from login API call. This should NOT be used in combination with API Secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "rsu_api_key",
"in": "query",
"description": "API v2 key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sp_api_key",
"in": "query",
"description": "Super partner API key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-SECRET",
"in": "header",
"description": "API v2 or super partner secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "Format of response. The default if not sent is `xml`, but `json` is preferred.",
"required": false,
"schema": {
"type": "string",
"enum": [
"xml",
"json",
"csv"
],
"default": "xml"
}
},
{
"name": "race_id",
"in": "query",
"description": "ID of race.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "event_id",
"in": "query",
"description": "ID of event.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "individual_result_set_id",
"in": "query",
"description": "ID of result set.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "include_total_finishers",
"in": "query",
"description": "Indicates whether or not to include total finishers in result set metadata. (Not supported for CSV)",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_split_time_ms",
"in": "query",
"description": "Indicates whether or not to include milliseconds in split times.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "modified_after_timestamp",
"in": "query",
"description": "Get results modified after a given timestamp",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "supports_nb",
"in": "query",
"description": "Does integration support non-binary X gender?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "page",
"in": "query",
"description": "Page number to get.",
"required": false,
"schema": {
"type": "integer",
"default": "1"
}
},
{
"name": "results_per_page",
"in": "query",
"description": "Number of results per page.",
"required": false,
"schema": {
"type": "integer",
"default": "50"
}
},
{
"name": "first_name",
"in": "query",
"description": "Search for results by first name.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last_name",
"in": "query",
"description": "Search for results by last name.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"in": "query",
"description": "Search for results by gender.",
"required": false,
"schema": {
"type": "string",
"enum": [
"M",
"F"
]
}
},
{
"name": "bib_num",
"in": "query",
"description": "Search for results by bib number.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "registration_id",
"in": "query",
"description": "Search for results by registration ID.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "min_place",
"in": "query",
"description": "Search for results by minimum finishing place.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "max_place",
"in": "query",
"description": "Search for results by maximum finishing place.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "min_age",
"in": "query",
"description": "Search for results by minimum age.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "max_age",
"in": "query",
"description": "Search for results by maximum age.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "state",
"in": "query",
"description": "Search for results by state.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "country",
"in": "query",
"description": "Search for results by country.",
"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"
]
}
}
],
"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"
]
}
}
}
}
