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

Get Race

Gets information about a specific race, including the race name, dates, URL, location, and events. Event start and end times are in the timezone of the race. All other dates/times are in Eastern Time. Additional race heading and links can be retrieved with the appropriate parameters.

A single race can be reused from one year to the next. By default, the output includes all events, including past events. To get just future events, use the future_events_only parameter

Age Based Pricing Data

Each age based pricing entry has the following fields:

  • age_group_pricing_id - ID of the row.
  • start_time - Start time for this pricing.
  • end_time - End time for this pricing.
  • race_fee - Event cost for this age range.
  • min_age - Min age in the range.
  • max_age - Max age in the range.
  • no_giveaway - “T” if participants in this range are not allowed to get a giveaway. “F” otherwise.
  • no_membership_price_adjustments - “T” if participants in this range are not allowed to also use membership based discounts. “F” otherwise.

Question Data

Each question has the following fields:

  • question_id - Question ID
  • question_text - Question text
  • question_type - Question type as human readable string
  • question_type_code - Question type code:
    • F: Freeform
    • B: Boolean (T/F)
    • S: Select box list of predefined responses.
    • R: Radio buttons of predefined responses.
    • C: Checkboxes of predefined responses (Allows multiple selection).
    • T: Time input.
    • A: Text box.
  • standard_question_type - Standard question type code:
    • ice_name: Emergency Contact Name
    • ice_phone: Emergency Contact Phone
    • sms_race_updates: Sign up for text message updates from the race.
  • question_validation_type - Freeform questions may have a validation type. This can none, uint, int, float, email, phone, date, char_limit, or allowed_values.
  • response_uniqueness_constraint - Response uniqueness constraint
    • 0: Not Unique
    • 1: Unique to Race
    • 2: Unique to Event
    • 3: Unique to Group
  • individual - "T" if this question should be asked for each registrant. "F" if it should be asked once per transaction.
  • required - Is the question required? T/F
  • skip_for_event_ids - Event IDs that the question should NOT be asked for.
  • responses - Predefined responses if applicable.
  • For time input type questions only: min_time - The minimum allowed time in "hh:mm:ss" format.
  • For time input type questions only: max_time - The maximum allowed time in "hh:mm:ss" format.
  • parent_question_id - ID of parent question, if applicable
    • parent_visible_bool_response - If the parent question is a T/F question, the response for the parent question that indicates that this question should be asked.
    • parent_visible_response_ids - If the parent question has possible responses, the response id(s) for the parent question that indicates that this question should be asked.

Registration Add-ons Data

Each add-on has the following fields:

  • addon_id - Add-on ID.
  • addon_name - Add-on name.
  • addon_desc - Optional description of the add-on.
  • addon_desc_html - Optional description of the add-on with HTML support.
  • addon_price - Add-on price.
  • min_quantity_per_transaction - Minimum quantity that must be purchased per transaction.
  • max_quantity_per_transaction - Maximum quantity that must be purchased per transaction.
  • per_registrant - "T" if this add-on should be asked for each registrant. "F" otherwise.
  • min_quantity_per_registrant - Minimum quantity that must be purchased per registrant.
  • max_quantity_per_registrant - Maximum quantity that must be purchased per registrant.
  • per_registrant_event - "T" if this add-on should be asked for each event each registrant is registering for. "F" otherwise.
  • min_quantity_per_registrant_event - Minimum quantity that must be purchased per registrant per event.
  • max_quantity_per_registrant_event - Maximum quantity that must be purchased per registrant per event.
  • quantity_available - Maximum total quantity available
  • available_from - When the add-on is available from (may be blank)
  • available_from_ts - When the add-on is available from as UNIX timestamp (may be blank)
  • available_until - When the add-on is available until (may be blank)
  • available_until_ts - When the add-on is available until as UNIX timestamp (may be blank)
  • only_if_waiver_signed - "T" if this add-on can only be purchased when the race waiver is signed. "F" otherwise.
  • applicable_event_ids - List of event IDs that add-on is valid for
  • addon_options - List of options (if applicable)

Membership Settings Data

Each membership setting has the following fields:

  • membership_setting_id - Membership setting ID.
  • membership_setting_name - Membership setting name.
  • price_adjustment - Price adjustment for membership.
  • apply_price_adjustment_for_non_member - "T" if this the price adjustment should be applied if the registrant is not a member. "F" otherwise.
  • membership_setting_addl_field - Optional additional field information if the registrant is a member. May contain the following:
    • field_text - Field text.
    • required - Is a response required? “T” if required. “F” otherwise.
    • min_length - Minimum length for response.
    • max_length - Maximum length for response.
    • format - Validation format for response. See the below legend.
      • 1 - Any format (default).
      • 2 - Alphabetical characters only.
      • 3 - Numeric characters only.
      • 4 - Alphanumeric characters only.
  • expires_x_days_before_event - Number of days before the event that the membership setting is must be used by.
  • user_notice - Optional user notice for the membership.
  • yes_option_text - Optional text for the "Yes" option.
  • no_option_text - Optional text for the "No" option.
  • usatf_specific - "T" if this is a USATF specific membership. "F" otherwise.
  • usat_specific - "T" if this is a USAT specific membership. "F" otherwise.
  • usat_event_id - Optional USAT event ID.
  • usat_external_validation - "T" if the USAT license will be validated with USAT servers.
  • usat_one_day_license_required - "T" if a one day USAT license is required.
  • require_first_registrant_waiver - "T" if the first registrant in a transaction is required to sign the waiver during registration.
  • ussa_specific - "T" if this is a USSA specific membership. "F" otherwise.
  • usac_specific - "T" if this is a USAC specific membership. "F" otherwise.

Corral Settings Data

Each event can have a corral_settings field:

  • ask_for_estimated_finish_time - "T" if the registrant should be asked for an estimated finish time. "F" otherwise.
  • min_finish_time_sec - Optional minimum finish time allowed.
  • max_finish_time_sec - Optional maximum finish time allowed.
  • male_max_finish_time_sec_requiring_verification - Optional maximum finish time for males where participants should be asked for a results URL to verify their time.
  • female_max_finish_time_sec_requiring_verification - Optional maximum finish time for females where participants should be asked for a results URL to verify their time.
  • corral_selection_during_registration - "T" if the registrant should be asked to select a corral during registration. "F" otherwise.
  • corrals - A list of selectable corrals.
    • race_corral_id - Corral ID.
    • corral_name - Smart corral name.
    • corral_start_desc - Short text description of when the corral starts.
    • corral_desc - Full corral description.

Question Application Types

Certain questions are set up for use with specific features. They do not show with normal questions during race registration. If you do not set supports_question_application_types to T when you call this API, the response will not include any question that has an application type set. If you do, they will be returned and the JSON response will include a application_type field that indicates where this question applies. Note that this field is only included in the JSON, not XML, response format. The current possible values for application_type are the following, but your integration should be able to handle additional types added in the future.

  • fundraiser_commitment: Fundraiser Minimum Commitment Level Question

URL

https://www.givesignup.org/rest/race/:race_id

HTTP Method

GET

Standard Parameters

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

Parameters

Parameter HTTP Method Default Description Datatype
race_id
Required		 GET ID of race. uint
future_events_only GET F Only outputs events that occur in the future. bool
most_recent_events_only GET F Only outputs most recent events for the race. bool
race_event_days_id GET Get events by race_event_days_id int
race_headings GET F Include race headings in the output. bool
include_waiver GET F Should waiver be included? bool
include_multiple_waivers GET F Should multiple waivers be included? bool
include_participant_caps GET F Should participant caps be included? bool
include_age_based_pricing GET F Should information on age based pricing be included? bool
include_giveaway_details GET F Should give-away (e.g. T-shirt) details be included? This will include options, such as sizes. bool
include_questions GET F Should questions be included? bool
include_addons GET F Should registration add-ons be included? bool
include_membership_settings GET F Should membership settings be included? bool
include_corral_settings GET F Should corral settings be included? bool
include_donation_settings GET F Should donations settings be included? bool
include_extra_date_info GET F Should extra information about cancellations and postponements be included? bool
supports_question_application_types GET F Does your integration support question application types? bool

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.