Get race groups/teams.
An XML response will look similar to this example:
<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE events PUBLIC "-//RunSignUp//API" "/rest/rsu.dtd"> <race_teams> <race_team> <team_id>11677</team_id> <team_name>Team 1</team_name> <team_type_id>1123</team_type_id> <team_age_restriction_id></team_age_restriction_id> <team_gender>M</team_gender> <team_bib_num>1</team_bib_num> <team_member_current_count>5</team_member_current_count> <last_modified_ts>123456789</last_modified_ts> </race_team> <race_team> <team_id>11678</team_id> <team_name>Team 2</team_name> <team_type_id>1123</team_type_id> <team_age_restriction_id></team_age_restriction_id> <team_gender>F</team_gender> <team_bib_num></team_bib_num> <team_member_current_count>3</team_member_current_count> <last_modified_ts>123456789</last_modified_ts> </race_team> <race_team> <team_id>11663</team_id> <team_name>Team 3</team_name> <team_type_id>1123</team_type_id> <team_age_restriction_id></team_age_restriction_id> <team_gender>C</team_gender> <team_bib_num>2</team_bib_num> <team_member_current_count>1</team_member_current_count> <last_modified_ts>123456789</last_modified_ts> </race_team> </race_teams>
In this response, "team_gender" can be empty, "M", "F", or "C" (for Co-ed).
| 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 or list of event ids separated by commas. | id_list |
|
modified_since |
GET | Get teams modified on or after a given time. If set, groups are returned in order of last modified date. Otherwise, by group name. | unix_timestamp |
|
page |
GET | 1 | Page number to get. | uint |
results_per_page |
GET | 50 | Number of results per page. | uint |
include_group_sizes |
GET | F | Include group sizes | bool |
{
"openapi": "3.0.3",
"info": {
"title": "Get Race Groups/Teams",
"description": "Get race groups/teams.",
"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": "Race Groups/Teams",
"description": "APIs related to Race Groups/Teams"
}
],
"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/teams": {
"get": {
"tags": [
"Race Groups/Teams"
],
"summary": "Get Race Groups/Teams",
"description": "Get race groups/teams.",
"operationId": "race_:race_id_teams",
"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 or list of event ids separated by commas.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modified_since",
"in": "query",
"description": "Get teams modified on or after a given time. If set, groups are returned in order of last modified date. Otherwise, by group name.",
"required": false,
"schema": {
"type": "string"
}
},
{
"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": "include_group_sizes",
"in": "query",
"description": "Include group sizes",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
}
],
"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"
]
}
}
}
}
