Use this API to get a list of participants that were removed from an event in a race.
Gets participants that were removed from a specific event in a race, including basic registration information and user information. Removed participants refers to registrants who:
cleared).removed).transferred).deferred).
The string in parenthesis is the code that will appear in the removed_reason field of the registration.
The transferred registrations will include a new_registration_id field.
Please note that this API returns results in pages.
The page, results_per_page, and sort parameters can be used to control paging.
You should consider using after_registration_id and/or modified_after_timestamp to download registrations since the last API request when you download participants over time.
When using modified_after_timestamp, note that it returns removed participants that have been modified on or after the specified timestamp.
If modified_after_timestamp is used in conjunction with the highest returned modified timestamp for subsequent API calls, you may need to increment modified_after_timestamp to prevent the same removed participant(s) from being returned each time.
{
"event": {
"event_id": 12890,
"participants": [
{
"user": {
"user_id": 123654,
"first_name": "Jane",
"middle_name": null,
"last_name": "Doe",
"email": "jane.doe@example.com",
"address": {
"street": "123 Main St.",
"city": "Moorestown",
"state": "NJ",
"zipcode": "08057",
"country_code": "US"
},
"dob": "1970-01-01",
"gender": "F",
"phone": "856-029-4233",
"profile_image_url": null
},
"registration_id": 2645629,
"age": 51,
"registration_date": "2021-09-07 15:20:36",
"last_modified": "2021-09-23 09:54:37",
"last_modified_ts": 1632405277,
"imported": "F",
"race_fee": "$55.00",
"processing_fee": "$2.75",
"processing_fee_paid_by_user": "$2.75",
"processing_fee_paid_by_race": "$0.00",
"amount_paid": "$57.75",
"removed_reason": "removed",
"new_registration_id": null
}
]
}
}
| 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 |
|
page |
GET | 1 | Page number to get. | uint |
results_per_page |
GET | 50 | Number of results per page. | uint |
sort |
GET | registration_id ASC | Sort by "registration_id", "registration_date" or "last_modified" in ascending ("ASC") or descending ("DESC") order. | string |
after_registration_id |
GET | Get registrations after the given registration ID. | int |
|
modified_after_timestamp |
GET | Get registrations modified on or after a given time. | unix_timestamp |
|
condensed_format |
GET | Use the condensed format, which only includes IDs and the reason for removal from the race. | bool |
|
supports_nb |
GET | F | Does integration support non-binary X gender? | bool |
{
"openapi": "3.0.3",
"info": {
"title": "Get Removed Race Participants",
"description": "Get removed race participants.",
"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 Participants",
"description": "APIs related to Race Participants"
}
],
"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/removed-participants": {
"get": {
"tags": [
"Race Participants"
],
"summary": "Get Removed Race Participants",
"description": "Get removed race participants.",
"operationId": "race_:race_id_removed_participants",
"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": "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": "sort",
"in": "query",
"description": "Sort by \"registration_id\", \"registration_date\" or \"last_modified\" in ascending (\"ASC\") or descending (\"DESC\") order.",
"required": false,
"schema": {
"type": "string",
"default": "registration_id ASC"
}
},
{
"name": "after_registration_id",
"in": "query",
"description": "Get registrations after the given registration ID.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "modified_after_timestamp",
"in": "query",
"description": "Get registrations modified on or after a given time.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condensed_format",
"in": "query",
"description": "Use the condensed format, which only includes IDs and the reason for removal from the race.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
]
}
},
{
"name": "supports_nb",
"in": "query",
"description": "Does integration support non-binary X gender?",
"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": [
"partners",
"race_directors",
"timers"
]
}
}
}
}
