Use this API to get entity info for an API key.
The entity_type can be one of:
race, partner, ticket_event, club.
Additional types may be added in the future.
The entity_specific_id is the ID associated with that entity type.
For example, a race entity will return the race ID in this field.
{
"generic_entity_id": 999,
"entity_type": "race",
"entity_name": "My Race Name",
"entity_specific_id": 111
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
rsu_api_keyRequired |
GET | API key. | string |
|
X-RSU-API-SECRETRequired |
HTTP Header | API secret. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Get V2 API Key Entity Info",
"description": "Get entity information for a v2 API key.",
"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 Info",
"description": "APIs related to Basic Info"
}
],
"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"
}
]
},
"V2AuthInfoEntityInfoGetResponse": {
"type": "object",
"title": "API Key Entity Info Response",
"description": "Response containing information about the entity associated with an API key",
"properties": {
"generic_entity_id": {
"type": "integer",
"description": "Unique identifier for the generic entity"
},
"entity_type": {
"type": "string",
"description": "Type of entity represented by the API key"
},
"entity_name": {
"type": "string",
"description": "Name of the entity"
},
"entity_specific_id": {
"type": "string",
"description": "Entity-specific identifier"
}
},
"required": [
"generic_entity_id",
"entity_type",
"entity_name",
"entity_specific_id"
],
"example": {
"generic_entity_id": 123456,
"entity_type": "race",
"entity_name": "Example Race Name",
"entity_specific_id": "12345"
}
}
},
"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/auth-info/entity-info.json": {
"get": {
"tags": [
"Basic Info"
],
"summary": "Get V2 API Key Entity Info",
"description": "Get entity information for a v2 API key.",
"operationId": "v2_auth_info_entity_info_json",
"parameters": [
{
"name": "rsu_api_key",
"in": "query",
"description": "API key.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-SECRET",
"in": "header",
"description": "API secret.",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKey": [],
"apiSecret": []
}
],
"responses": {
"200": {
"description": "API Key Entity Info Response - Response containing information about the entity associated with an API key",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2AuthInfoEntityInfoGetResponse"
}
}
}
},
"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"
]
}
}
}
}
