This API returns race theme information such as color schemes, logos, and banner images.
The response structure varies based on whether the race is using Website V1 or Website V2:
banner_image and page_banner_image directly in the race_theme objectbanner_image in the race_theme object
The color_scheme object contains two types of colors: base theme colors (background_color, font_color, primary_color, secondary_color, tertiary_color, and quaternary_color) which are the core colors defined in the race’s color scheme.
SCSS-calculated colors (button background/text colors and contrasted text color) are dynamically computed using TicketSignup’s SCSS theming system.
All color values are returned as hex strings without the "#" prefix.
{
"race_theme": {
"color_scheme": {
"color_scheme_id": 42,
"scheme_name": "Sunset Orange Theme",
"background_color": "faf3e0",
"font_color": "222222",
"primary_color": "ff6b35",
"secondary_color": "004e89",
"tertiary_color": "1a659e",
"quaternary_color": "2e4057",
"primary_button_background_color": "FF6B35",
"primary_button_text_color": "FFFFFF",
"secondary_button_background_color": "004E89",
"secondary_button_text_color": "FFFFFF",
"tertiary_button_background_color": "1A659E",
"tertiary_button_text_color": "FFFFFF",
"quaternary_button_background_color": "2E4057",
"quaternary_button_text_color": "FFFFFF",
"contrasted_text_color": "222222"
},
"race_logo": {
"race_image_id": 7,
"small": "https://example.com/static/races/race9999-logo-small.png",
"medium": "https://example.com/static/races/race9999-logo-medium.png",
"large": "https://example.com/static/races/race9999-logo-large.png",
},
"banner_image": {
"banner_image_id": 56,
"primary": "https://example.com/race-banners/v1_primary_480x160.jpg",
"small": "https://example.com/race-banners/v1_small_480x160.jpg",
"medium": "https://example.com/race-banners/v1_medium_960x320.jpg",
"extra_large": "https://example.com/race-banners/v1_extralarge_1200x400.jpg",
}
}
}
{
"race_theme": {
"color_scheme": {
"color_scheme_id": 42,
"scheme_name": "Sunset Orange Theme",
"background_color": "faf3e0",
"font_color": "222222",
"primary_color": "ff6b35",
"secondary_color": "004e89",
"tertiary_color": "1a659e",
"quaternary_color": "2e4057",
"primary_button_background_color": "FF6B35",
"primary_button_text_color": "FFFFFF",
"secondary_button_background_color": "004E89",
"secondary_button_text_color": "FFFFFF",
"tertiary_button_background_color": "1A659E",
"tertiary_button_text_color": "FFFFFF",
"quaternary_button_background_color": "2E4057",
"quaternary_button_text_color": "FFFFFF",
"contrasted_text_color": "222222"
},
"race_logo": {
"race_image_id": 7,
"small": "https://example.com/static/races/race9999-logo-small.png",
"medium": "https://example.com/static/races/race9999-logo-medium.png",
"large": "https://example.com/static/races/race9999-logo-large.png",
},
"banner_image": {
"banner_image_id": 88,
"primary": "https://example.com/race-banners/v2_primary_480x160.jpg",
"small": "https://example.com/race-banners/v2_small_480x160.jpg",
"medium": "https://example.com/race-banners/v2_medium_960x320.jpg",
"extra_large": "https://example.com/race-banners/v2_extralarge_1200x400.jpg",
},
"page_banner_image": {
"page_banner_image_id": 91,
"primary": "https://example.com/race-banners/page_primary_480x160.jpg",
"small": "https://example.com/race-banners/page_small_480x160.jpg",
"medium": "https://example.com/race-banners/page_medium_960x320.jpg",
"extra_large": "https://example.com/race-banners/page_extralarge_1200x400.jpg",
}
}
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
api_key |
GET | Race API key. | string |
|
api_secret |
GET | Race API secret. | string |
|
checkin_api_key |
GET | Checkin API key. | string |
|
X-CHECKIN-API-SECRET |
HTTP Header | Checkin API secret. | string |
|
rsu_api_key |
GET | API key | string |
|
X-RSU-API-SECRET |
HTTP Header | API secret | string |
|
Authorization |
HTTP Header | OAuth 2.0 Authorization header (e.g. `Bearer ...`). | string |
|
race_idRequired |
GET | Race ID. | uint |
{
"openapi": "3.0.3",
"info": {
"title": "Get Race Theme",
"description": "Get race theme.",
"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": "Basic Race Information",
"description": "APIs related to Basic Race Information"
}
],
"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"
}
}
},
"paths": {
"/v2/race-theme/race-theme.json": {
"get": {
"tags": [
"Basic Race Information"
],
"summary": "Get Race Theme",
"description": "Get race theme.",
"operationId": "v2_race_theme_race_theme_json",
"parameters": [
{
"name": "api_key",
"in": "query",
"description": "Race API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "api_secret",
"in": "query",
"description": "Race API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "checkin_api_key",
"in": "query",
"description": "Checkin API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-CHECKIN-API-SECRET",
"in": "header",
"description": "Checkin API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"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": "Authorization",
"in": "header",
"description": "OAuth 2.0 Authorization header (e.g. `Bearer ...`).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "race_id",
"in": "query",
"description": "Race ID.",
"required": true,
"schema": {
"type": "integer"
}
}
],
"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"
]
}
}
}
}
