Get a list of result sets for an event.
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
api_key |
GET | API Key | string |
|
api_secret |
GET | 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 |
|
Authorization |
HTTP Header | Authorization Header. If using OAuth 2.0, fill this in with `Bearer <token>`. | 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 |
|
include_total_finishers |
GET | F | Indicates whether or not to include total finishers in result set metadata. (Not supported for CSV) | bool |
include_division_finishers |
GET | F | Indicates whether or not to include division finishers in result set metadata. (Not supported for CSV). Division finishers will only be included if include_total_finishers is also set to T. | bool |
{
"openapi": "3.0.3",
"info": {
"title": "Get Event Result Sets",
"description": "List 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://api.runsignup.com/rest",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Results",
"description": "APIs related to Results"
}
],
"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"
}
]
},
"Race_raceIdResultsGetResultSetsGetResponse": {
"type": "object",
"title": "Event Result Sets Response",
"description": "Response containing a list of result sets for an event.",
"properties": {
"individual_results_sets": {
"type": "array",
"description": "Array of result sets",
"example": [
{
"individual_result_set_id": 123,
"individual_result_set_name": "Overall Results",
"public_results": "T",
"sort_order": 0,
"results_source_name": "RunSignUp",
"results_source_url": "https://example.com",
"preliminary_results": "F",
"pace_type": "T",
"team_column_display_type": 1,
"alt_event_ids": [
456,
789
],
"hide_splits_in_results": "F",
"hide_event_names": "F",
"disable_notifications": "F",
"result_questions_url": "https://example.com/contact",
"results_headers": {
"result_id": "Result Id",
"place": "Place"
},
"results": [
{
"result_id": 1001,
"place": "1",
"bib": "123",
"first_name": "John",
"last_name": "Smith",
"gender": "M",
"city": "Philadelphia",
"state": "PA",
"country_code": "US",
"clock_time": "00:17:30.5",
"chip_time": "00:17:30.0",
"age": "35",
"age_percentage": "72.5%"
}
]
}
],
"items": {
"type": "object",
"description": "A single result set",
"properties": {
"individual_result_set_id": {
"type": "integer",
"description": "ID of the result set"
},
"individual_result_set_name": {
"type": "string",
"description": "Name of the result set"
},
"public_results": {
"type": "string",
"description": "Whether the results are public (T) or private (F)",
"enum": [
"T",
"F"
]
},
"sort_order": {
"type": "integer",
"description": "Sort order value for this result set"
},
"results_source_name": {
"type": "string",
"description": "Name of the source of the results"
},
"results_source_url": {
"type": "string",
"description": "URL of the source of the results"
},
"preliminary_results": {
"type": "string",
"description": "Whether these are preliminary results (T) or final results (F)",
"enum": [
"T",
"F"
]
},
"pace_type": {
"type": "string",
"description": "The pace type for this result set (T=minutes per mile, t=minutes per kilometer, M=miles per hour, K=kilometers per hour, N=none (don`t display))"
},
"team_column_display_type": {
"type": "integer",
"description": "Team column display type (0=hide, 1=show if there are team results, 2=show)"
},
"alt_event_ids": {
"type": "array",
"description": "Array of alternate event IDs linked to this result set",
"nullable": true,
"items": {
"type": "integer",
"description": "Alternative event ID"
}
},
"hide_splits_in_results": {
"type": "string",
"description": "Whether splits are hidden in results (T) or shown (F)",
"enum": [
"T",
"F"
]
},
"hide_event_names": {
"type": "string",
"description": "Whether event names are hidden (T) or shown (F)",
"enum": [
"T",
"F"
]
},
"disable_notifications": {
"type": "string",
"description": "Whether notifications for this result set are disabled (T) or enabled (F)",
"enum": [
"T",
"F"
]
},
"result_questions_url": {
"type": "string",
"description": "URL for submitting result questions or issues",
"nullable": true
},
"num_finishers": {
"type": "integer",
"description": "Total number of finishers in this result set. Present when include_total_finishers=T",
"nullable": true,
"x-response-field-inclusion": [
{
"request-parameter": "include_total_finishers",
"value": "T"
}
]
},
"num_division_finishers": {
"type": "object",
"description": "An object mapping division IDs to the number of finishers in each division. Present when include_total_finishers=T AND include_division_finishers=T",
"nullable": true,
"x-response-field-inclusion": [
{
"request-parameter": "include_total_finishers",
"value": "T"
},
{
"request-parameter": "include_division_finishers",
"value": "T",
"requires": [
"include_total_finishers"
]
}
],
"additionalProperties": true,
"properties": {
"1": {
"description": "[EXAMPLE] Division 1 finisher count (This property is not required - the object can contain any properties)",
"example": 75,
"type": "integer"
},
"2": {
"description": "[EXAMPLE] Division 2 finisher count (This property is not required - the object can contain any properties)",
"example": 75,
"type": "integer"
}
},
"x-key-naming-convention": "Keys are division IDs (integers) mapping to finisher counts (integers)"
},
"results_headers": {
"type": "object",
"description": "Mapping of result column keys to display names",
"additionalProperties": true,
"properties": {
"result_id": {
"description": "[EXAMPLE] Result Id (This property is not required - the object can contain any properties)",
"example": "Result Id",
"type": "string"
},
"place": {
"description": "[EXAMPLE] Place (This property is not required - the object can contain any properties)",
"example": "Place",
"type": "string"
},
"bib": {
"description": "[EXAMPLE] Bib (This property is not required - the object can contain any properties)",
"example": "Bib",
"type": "string"
},
"first_name": {
"description": "[EXAMPLE] First Name (This property is not required - the object can contain any properties)",
"example": "First Name",
"type": "string"
},
"last_name": {
"description": "[EXAMPLE] Last Name (This property is not required - the object can contain any properties)",
"example": "Last Name",
"type": "string"
},
"gender": {
"description": "[EXAMPLE] Gender (This property is not required - the object can contain any properties)",
"example": "Gender",
"type": "string"
},
"city": {
"description": "[EXAMPLE] City (This property is not required - the object can contain any properties)",
"example": "City",
"type": "string"
},
"state": {
"description": "[EXAMPLE] State (This property is not required - the object can contain any properties)",
"example": "State",
"type": "string"
},
"country_code": {
"description": "[EXAMPLE] Country (This property is not required - the object can contain any properties)",
"example": "Country",
"type": "string"
},
"clock_time": {
"description": "[EXAMPLE] Clock Time (This property is not required - the object can contain any properties)",
"example": "Clock Time",
"type": "string"
},
"chip_time": {
"description": "[EXAMPLE] Chip Time (This property is not required - the object can contain any properties)",
"example": "Chip Time",
"type": "string"
},
"pace": {
"description": "[EXAMPLE] Pace (This property is not required - the object can contain any properties)",
"example": "Pace",
"type": "string"
},
"age": {
"description": "[EXAMPLE] Age (This property is not required - the object can contain any properties)",
"example": "Age",
"type": "string"
},
"age_percentage": {
"description": "[EXAMPLE] Age Percentage (This property is not required - the object can contain any properties)",
"example": "Age Percentage",
"type": "string"
}
},
"x-pattern-properties": {
"split-\\d+": "Split time for a specific split (e.g., split-1, split-2)",
"split-\\d+-pace": "Split pace for a specific split (e.g., split-1-pace)",
"split-\\d+-place": "Split place for a specific split (e.g., split-1-place)",
"custom-field-\\d+": "Custom field value (e.g., custom-field-123)",
"division-\\d+-placement": "Division placement (e.g., division-1-placement)"
},
"x-key-naming-convention": "Keys follow the pattern: standard fields are lowercase with underscores, dynamic fields use hyphens and IDs (e.g., split-1, custom-field-123)"
},
"results": {
"type": "array",
"description": "Array of individual results in this result set",
"example": [
{
"result_id": 1001,
"place": "1",
"bib": "123",
"first_name": "John",
"last_name": "Smith",
"gender": "M",
"city": "Philadelphia",
"state": "PA",
"country_code": "US",
"clock_time": "00:17:30.5",
"chip_time": "00:17:30.0",
"age": "35",
"age_percentage": "72.5%"
}
],
"items": {
"type": "object",
"description": "A single individual result",
"properties": {
"result_id": {
"type": "integer",
"description": "ID of the result"
},
"place": {
"type": "string",
"description": "Overall finishing place"
},
"bib": {
"type": "string",
"description": "Bib number"
},
"first_name": {
"type": "string",
"description": "First name of the participant"
},
"last_name": {
"type": "string",
"description": "Last name of the participant"
},
"gender": {
"type": "string",
"description": "Gender of the participant (M, F, or N for non-binary)"
},
"city": {
"type": "string",
"description": "City of the participant"
},
"state": {
"type": "string",
"description": "State of the participant"
},
"country_code": {
"type": "string",
"description": "Country code of the participant"
},
"clock_time": {
"type": "string",
"description": "Clock time as formatted time string"
},
"chip_time": {
"type": "string",
"description": "Chip time as formatted time string"
},
"pace": {
"type": "string",
"description": "Pace formatted according to pace_type setting",
"nullable": true
},
"age": {
"type": "string",
"description": "Age of the participant"
},
"age_percentage": {
"type": "string",
"description": "Age-graded performance percentage"
}
}
}
},
"registration_ids": {
"type": "array",
"description": "Array of registration IDs associated with the results",
"nullable": true,
"items": {
"type": "integer",
"description": "Registration ID"
}
}
},
"required": [
"individual_result_set_id",
"individual_result_set_name",
"public_results",
"sort_order",
"results_source_name",
"results_source_url",
"preliminary_results",
"pace_type",
"team_column_display_type",
"hide_splits_in_results",
"hide_event_names",
"disable_notifications",
"result_questions_url"
]
}
}
},
"required": [
"individual_results_sets"
],
"example": {
"individual_results_sets": [
{
"individual_result_set_id": 123,
"individual_result_set_name": "Overall Results",
"public_results": "T",
"sort_order": 0,
"results_source_name": "RunSignUp",
"results_source_url": "https://example.com",
"preliminary_results": "F",
"pace_type": "T",
"team_column_display_type": 1,
"alt_event_ids": [
456,
789
],
"hide_splits_in_results": "F",
"hide_event_names": "F",
"disable_notifications": "F",
"result_questions_url": "https://example.com/contact",
"num_finishers": 150,
"num_division_finishers": {
"1": 75,
"2": 75
},
"results_headers": {
"result_id": "Result Id",
"place": "Place",
"bib": "Bib",
"first_name": "First Name",
"last_name": "Last Name",
"gender": "Gender",
"city": "City",
"state": "State",
"country_code": "Country",
"clock_time": "Clock Time",
"chip_time": "Chip Time",
"pace": "Pace",
"age": "Age",
"age_percentage": "Age Percentage"
},
"results": [
{
"result_id": 1001,
"place": "1",
"bib": "123",
"first_name": "John",
"last_name": "Smith",
"gender": "M",
"city": "Philadelphia",
"state": "PA",
"country_code": "US",
"clock_time": "00:17:30.5",
"chip_time": "00:17:30.0",
"pace": "5:38 min/mi",
"age": "35",
"age_percentage": "72.5%"
},
{
"result_id": 1002,
"place": "2",
"bib": "456",
"first_name": "Jane",
"last_name": "Doe",
"gender": "F",
"city": "New York",
"state": "NY",
"country_code": "US",
"clock_time": "00:18:45.2",
"chip_time": "00:18:44.9",
"pace": "6:02 min/mi",
"age": "28",
"age_percentage": "75.1%"
}
],
"registration_ids": [
2001,
2002
]
}
]
}
}
},
"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-result-sets": {
"get": {
"tags": [
"Results"
],
"summary": "Get Event Result Sets",
"description": "List all result sets for an event.",
"operationId": "race_:race_id_results_get_result_sets",
"parameters": [
{
"name": "race_id",
"in": "path",
"description": "Path parameter: race_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"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": "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": "Authorization",
"in": "header",
"description": "Authorization Header. If using OAuth 2.0, fill this in with `Bearer <token>`.",
"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": "event_id",
"in": "query",
"description": "ID of event.",
"required": true,
"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_division_finishers",
"in": "query",
"description": "Indicates whether or not to include division finishers in result set metadata. (Not supported for CSV). Division finishers will only be included if include_total_finishers is also set to T.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
}
],
"security": [
{
"apiKey": [],
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Event Result Sets Response - Response containing a list of result sets for an event.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Race_raceIdResultsGetResultSetsGetResponse"
}
}
}
},
"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"
]
}
}
}
}
