Gets participants for a specific event in a race, including the user information, registration date, and payment information.
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 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 participant(s) from being returned each time.
signed_waiver_details
will only be returned when the include_multiple_waivers
parameter is set to T
and is only supported for the JSON format.
{ "event": { "event_id": 11111, "participants": [] }, "participants": [ { "user": { "user_id": 123123123, "first_name": "Margie", "middle_name": null, "last_name": "Stephens", "email": "margie.stephens@example.com", "address": { "street": "960 Avondale Ave", "city": "Moorestown", "state": "NJ", "zipcode": "08057", "country_code": "US" }, "dob": "1986-01-06", "gender": "F", "phone": "856-850-1510", "profile_image_url": null }, "registration_id": 2645624, "event_id": 12890, "rsu_transaction_id": 263659, "transaction_id": "ay_852631042119552C_0", "bib_num": null, "chip_num": null, "age": 35, "registration_date": "9/7/2021 15:15", "team_id": null, "team_name": null, "team_type_id": null, "team_type": null, "team_gender": null, "team_bib_num": null, "last_modified": 1631042122, "imported": "F", "race_fee": "$55.00", "offline_payment_amount": "$0.00", "processing_fee": "$2.75", "processing_fee_paid_by_user": "$2.75", "processing_fee_paid_by_race": "$0.00", "partner_fee": "$0.00", "affiliate_profit": "$0.00", "extra_fees": "$0.00", "amount_paid": "$57.75", "usatf_discount_amount_in_cents": "$0.00", "usatf_discount_additional_field": null, "giveaway": null, "giveaway_option_id": null "fundraiser_id": 12345, "fundraiser_charity_id": null, "fundraiser_charity_name": null, "team_fundraiser_id": null, "multi_race_bundle_id": null, "multi_race_bundle": null, "signed_waiver_details": [ { "waiver_id": 123, "waiver_signed_ts": 1694007359 }, { "waiver_id": 124, "waiver_signed_ts": 1694007359 } ] } ] }
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_id Required |
GET | ID of race. | uint |
|
event_id Required |
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", "age", "name", "first_name", "last_name", "bib_num", "chip_num", "gender" in ascending ("ASC") or descending ("DESC") order. | string |
after_registration_id |
GET | Get registrations after the given registration ID | int |
|
before_registration_id |
GET | Get registrations before the given registration ID | int |
|
modified_after_timestamp |
GET | Get registrations modified on or after a given time | unix_timestamp |
|
registered_after_timestamp |
GET | Get registrations registered on or after a given time | unix_timestamp |
|
registered_before_timestamp |
GET | Get registrations registered on or before a given time | unix_timestamp |
|
include_counties |
GET | F | Should the US counties (NOT COUNTRY) be included. | bool |
include_template_participant |
GET | F | Should a template participant be included. Registration ID will be -1. | bool |
include_user_anonymous_flag |
GET | F | Should the is_anonymous flag be included on users? | bool |
include_questions |
GET | F | Should question responses be included. Ignored for CSV response type. | bool |
include_corrals |
GET | F | Should corrals be included. | bool |
include_est_finish |
GET | F | Should estimated finish times be included. | bool |
include_corp_teams |
GET | F | Should corporate teams be included. | bool |
include_registration_addons |
GET | F | Should registration add-ons be included. Ignored for CSV response type. | bool |
include_memberships |
GET | F | Should registration memberships be included. Ignored for CSV response type. | bool |
include_coupon_details |
GET | F | Should coupon details be included. | bool |
include_registration_notes |
GET | F | Should registration notes be included. | bool |
include_checkin_data |
GET | F | Should checkin data be included. | bool |
include_waiver_info |
GET | F | Should waiver info be included. | bool |
include_multiple_waivers |
GET | F | Should info for multiple waivers be included? | bool |
include_usat_waiver_info |
GET | F | Should USAT waiver info be included. | bool |
include_pending_lottery_selection |
GET | F | Should pending lottery selection participants be included. | bool |
exclude_registrations_via_super_event |
GET | F | Exclude event registrations that are due to the registrant signing up for a super event that includes this event. | bool |
include_shipping_address |
GET | F | Should shipping address be included (if enabled). | bool |
include_profile_type |
GET | F | Should profile type be included. | bool |
include_profile_image_url |
GET | F | Should profile image URLs be included. | bool |
supports_nb |
GET | F | Does integration support non-binary X gender? | bool |
include_fundraisers |
GET | F | Should fundraiser and team fundraiser information be included? | bool |
include_multi_race_bundle_info |
GET | F | Should multi-race bundle information be included? | bool |
Parameter | HTTP Method | Default | Description | Datatype |
---|---|---|---|---|
search_first_name |
GET | Search for users by first name. | string |
|
search_last_name |
GET | Search for users by last name. | string |
|
search_email |
GET | Search for users by email address. | string |
|
search_bib |
GET | Search for users by bib number. | uint |
{ "openapi": "3.0.3", "info": { "title": "Get Race Participants", "description": "Get participants for a race.", "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/participants": { "get": { "tags": [ "Race Participants" ], "summary": "Get Race Participants", "description": "Get participants for a race.", "operationId": "race_:race_id_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\", \"age\", \"name\", \"first_name\", \"last_name\", \"bib_num\", \"chip_num\", \"gender\" 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": "before_registration_id", "in": "query", "description": "Get registrations before 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": "registered_after_timestamp", "in": "query", "description": "Get registrations registered on or after a given time", "required": false, "schema": { "type": "string" } }, { "name": "registered_before_timestamp", "in": "query", "description": "Get registrations registered on or before a given time", "required": false, "schema": { "type": "string" } }, { "name": "include_counties", "in": "query", "description": "Should the US counties (NOT COUNTRY) be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_template_participant", "in": "query", "description": "Should a template participant be included. Registration ID will be -1.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_user_anonymous_flag", "in": "query", "description": "Should the is_anonymous flag be included on users?", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_questions", "in": "query", "description": "Should question responses be included. Ignored for CSV response type.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_corrals", "in": "query", "description": "Should corrals be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_est_finish", "in": "query", "description": "Should estimated finish times be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_corp_teams", "in": "query", "description": "Should corporate teams be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_registration_addons", "in": "query", "description": "Should registration add-ons be included. Ignored for CSV response type.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_memberships", "in": "query", "description": "Should registration memberships be included. Ignored for CSV response type.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_coupon_details", "in": "query", "description": "Should coupon details be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_registration_notes", "in": "query", "description": "Should registration notes be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_checkin_data", "in": "query", "description": "Should checkin data be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_waiver_info", "in": "query", "description": "Should waiver info be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_multiple_waivers", "in": "query", "description": "Should info for multiple waivers be included?", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_usat_waiver_info", "in": "query", "description": "Should USAT waiver info be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_pending_lottery_selection", "in": "query", "description": "Should pending lottery selection participants be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "exclude_registrations_via_super_event", "in": "query", "description": "Exclude event registrations that are due to the registrant signing up for a super event that includes this event.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_shipping_address", "in": "query", "description": "Should shipping address be included (if enabled).", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_profile_type", "in": "query", "description": "Should profile type be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_profile_image_url", "in": "query", "description": "Should profile image URLs be included.", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "supports_nb", "in": "query", "description": "Does integration support non-binary X gender?", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_fundraisers", "in": "query", "description": "Should fundraiser and team fundraiser information be included?", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "include_multi_race_bundle_info", "in": "query", "description": "Should multi-race bundle information be included?", "required": false, "schema": { "type": "boolean", "enum": [ "T", "F" ], "default": "F" } }, { "name": "search_first_name", "in": "query", "description": "Search for users by first name.", "required": false, "schema": { "type": "string" } }, { "name": "search_last_name", "in": "query", "description": "Search for users by last name.", "required": false, "schema": { "type": "string" } }, { "name": "search_email", "in": "query", "description": "Search for users by email address.", "required": false, "schema": { "type": "string" } }, { "name": "search_bib", "in": "query", "description": "Search for users by bib number.", "required": false, "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": [ "partners", "race_directors", "timers" ] } } } }