1. RunSignup
  2. API
  3. Methods
  4. Get Race Participants
API Overview Getting Started API Keys OAuth2 Authentication Documentation API Methods Error Codes Code Examples

Get Race Participants

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.

Response 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
				}
			]
		}
	]
}

URL

https://api.runsignup.com/rest/race/:race_id/participants

HTTP Method

GET

Standard Parameters

Parameter HTTP Method Default Description Datatype
api_key GET API Key string
api_secret GET 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
Authorization HTTP Header Authorization Header. If using OAuth 2.0, fill this in with `Bearer <token>`. string
format GET xml Format of response. The default if not sent is `xml`, but `json` is preferred. format

Parameters

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

User Search Parameters

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

If you continue to use this site, you consent to use all cookies. We use cookies to offer you a better browsing experience. Read how we use cookies and how you can control them by visiting our Privacy Policy.

If you continue to use this site, you consent to use all cookies.