Look up race series participants.
In the response format, when the race_series_participant_id is not null, an exact match has been found.
If potential matches are found, they will be listed in the possible_matches array.
If both race_series_participant_id is null and possible_matches is empty, no exact or potential match was found.
The errors array will contain any errors encountered during the matching process.
The optional include_super_events parameter allows you to include super events when matching by user ID.
This parameter is only applicable when matching_type is set to user_id.
If a participant is not found in the event specified by event_id, the lookup will check if the event is part of a super event and attempt to find a participant with the same user ID in that super event.
This can be useful when participants are registered under a super event instead of the individual event.
Note: This endpoint only allows OAuth 2.0 authentication and requires the user to be a director of the race series or a timer of a race that is included in the series. It is currently in beta and subject to change.
{
"columns": [
"registration_id",
"user_id",
"user_defined_id",
"first_name",
"last_name",
"gender",
"dob",
"age",
"email",
"phone",
"address1",
"city",
"state",
"zipcode",
"countrycode"
],
"participants": [
[622, null, null, "Dolores", "Nguyen", "F", "1981-06-25", 40, "dolores.nguyen@example.com", "856-655-7878", "1899 Saddle Dr", "Moorestown", "NJ", "08057", "US"],
[2650151, null, null, "Judd", "Daniels", "M", "1999-06-01", 27, "judd.daniels@example.com", "856-665-1683", "5833 College St", "Moorestown", "NJ", "08057", "US"],
[2649769, null, null, "Washington", "Campbell", "M", "1974-01-18", 52, "Test.daniels@example.com", "888-888-8888", "300 Mill St", "Moorestown", "NJ", "08057", "US"],
[2649697, null, null, "J", "Bailey", "M", "1967-03-13", 59, "Test1.daniels@example.com", "888-888-8888", "300 Mill St", "Moorestown", "NJ", "08057", "US"]
]
}
{
"race_series_participants": [
{
"row": 1,
"race_series_participant_id": null,
"possible_matches": [
{
"registration_id": null,
"user_id": null,
"race_series_participant_id": 3862,
"user_defined_id": null,
"first_name": "Dolores",
"last_name": "Nguyen",
"gender": "F",
"dob": "1981-06-25",
"age": 43,
"email": "dolores.nguyen@example.com",
"phone": "856-655-7878",
"address1": "1899 Saddle Dr",
"city": "Moorestown",
"state": "NJ",
"zipcode": "08057",
"countrycode": "US"
},
{
"registration_id": null,
"user_id": null,
"race_series_participant_id": 3865,
"user_defined_id": null,
"first_name": "Dolores",
"last_name": "Nguyen",
"gender": "F",
"dob": "1981-06-25",
"age": 43,
"email": "dnguyen@example.com",
"phone": "856-657-7851",
"address1": "198 Creek Rd",
"city": "Moorestown",
"state": "NJ",
"zipcode": "08057",
"countrycode": "US"
}
]
},
{
"row": 2,
"race_series_participant_id": 3861
},
{
"row": 3,
"race_series_participant_id": null,
"possible_matches": [
{
"registration_id": 3864,
"user_id": 3048333,
"race_series_participant_id": 3864,
"user_defined_id": null,
"first_name": "W",
"last_name": "Campbell",
"gender": "M",
"dob": "1974-01-18",
"age": 50,
"email": "Test.daniels@example.com",
"phone": "888-888-8888",
"address1": "300 Mill St",
"city": "Moorestown",
"state": "NJ",
"zipcode": "08057",
"countrycode": "US"
}
]
},
{
"row": 4,
"race_series_participant_id": null,
"error": "No match found."
}
]
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
AuthorizationRequired |
HTTP Header | OAuth 2.0 Authorization header (e.g. `Bearer ...`). | string |
|
race_series_idRequired |
GET | Race series ID. | uint |
|
race_series_year_idRequired |
GET | Race series year ID. | uint |
|
race_idRequired |
GET | Race ID. | uint |
|
event_idRequired |
GET | Event ID. | uint |
|
matching_typeRequired |
GET | Matching Type (registration_id, user_id, user_defined_id). | string |
|
include_super_events |
GET | false | Include searching super events if the user is not found in the specified event (only applies when matching by user ID). | bool |
requestRequired |
POST | JSON data containing participants to be used for lookup. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Look Up Race Series Participants (BETA)",
"description": "Look up race series participants.",
"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": "Race Series Scoring",
"description": "APIs related to Race Series Scoring"
}
],
"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-series/race-series-participants/lookup.json": {
"post": {
"tags": [
"Race Series Scoring"
],
"summary": "Look Up Race Series Participants (BETA)",
"description": "Look up race series participants.",
"operationId": "v2_race_series_race_series_participants_lookup_json",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "OAuth 2.0 Authorization header (e.g. `Bearer ...`).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "race_series_id",
"in": "query",
"description": "Race series ID.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "race_series_year_id",
"in": "query",
"description": "Race series year ID.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "race_id",
"in": "query",
"description": "Race ID.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "event_id",
"in": "query",
"description": "Event ID.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "matching_type",
"in": "query",
"description": "Matching Type (registration_id, user_id, user_defined_id).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include_super_events",
"in": "query",
"description": "Include searching super events if the user is not found in the specified event (only applies when matching by user ID).",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "false"
}
}
],
"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": [
"race_directors",
"timers"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"request": {
"type": "string"
}
},
"required": [
"request"
]
}
}
}
}
}
}
}
}
