Use this API to get race fundraisers.
Field amount_raised
can be included in the response by including parameter include_amount_raised
with a value of T
.
Field number_of_donations
can be included in the response by including parameter include_number_of_donations
with a value of T
.
Field fundraiser_primary_image_filename
can be included in the response by including parameter include_fundraiser_profile_images
with a value of T
.
{ "race_fundraisers": [ { "race_fundraiser_id": 123, "race_fundraiser_name": "Some Fundraiser Name", "parent_fundraiser_id": 567, "created_ts": 1111111111, "registration_id": 1234, "is_team_fundraiser": "F", "fundraiser_hidden": "T", "fundraiser_url": "https://runsignup.com/SomeFundraiserName", "fundraiser_token": "a1b2c3d4e", "fundraiser_owner": { "user_id": 123, "first_name": "John", "last_name": "Doe", "email": "example@example.com", "phone_number": "555-555-5555" }, "charity_id": "123", "charity_name": "Charity Name", "fundraiser_tagline": "This is a tagline.", "personal_message": "Some personal message.", "fundraising_goal": "$500.00", "fundraising_minimum": "$250.00", "amount_raised": "$250.00", "donation_period_id": 1, "applied_for_refund": "F", "last_modified_ts": 1111111123, "number_of_donations": 3, "fundraiser_primary_image_filename": "/path/to/image.png", "team_fundraiser_type_id": 1, "team_fundraiser_type": "Corporate", "umbrella_team_id": 2, "umbrella_team_name": "Umbrella Team" "external_fundraiser_id": "abc1234", "minimum_commitment_level_id": 1000, "minimum_commitment_level_name": "Minimum commitment level name", "minimum_commitment_level_amount": "$250.00" } ] }
Parameter | HTTP Method | Default | Description | Datatype |
---|---|---|---|---|
race_id Required |
GET | ID of race. | uint |
|
api_key Required |
GET | Race API key. | string |
|
api_secret Required |
GET | Race API secret. | string |
|
donation_period_id |
GET | Get fundraisers associated with a donation period ID. | uint |
|
num |
GET | 50 | Number of results per page. The allowed range per page is from 1 - 500, outside this range it defaults to 50 per page. | uint |
page |
GET | 1 | Number of pages. | uint |
modified_after_ts |
GET | Get fundraisers updated after the provided timestamp. | int |
|
modified_before_ts |
GET | Get fundraisers updated before the provided timestamp. | int |
|
include_amount_raised |
GET | F | Get amount raised for fundraisers? | bool |
modified_field |
GET | meta | Consider only metadata changes or metadata and donation amount changes? Allowed values are 'meta' or 'meta_or_donation'. | string |
include_number_of_donations |
GET | F | Include number of donations. | bool |
include_fundraiser_profile_images |
GET | F | Include fundraiser profile image. | bool |
included_fundraiser_types |
GET | any | Include fundraisers types. Allowed values: 'any', 'individuals', 'teams' | string |
include_fundraiser_type_info |
GET | F | Include team fundraiser type info. | bool |
include_umbrella_teams |
GET | F | Include umbrella team info. | bool |
include_import_data |
GET | F | (Deprecated: Use `include_external_fundraiser_ids` instead.) Include external fundraiser info. | bool |
include_external_fundraiser_ids |
GET | F | Include external fundraiser info. | bool |
include_minimum_commitment_data |
GET | F | Include minimum commitment info. | bool |
registration_id |
GET | Get fundraiser associated with a registration ID. | int |
|
fundraiser_id |
GET | Get fundraiser associated with a fundraiser ID. | int |