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_idRequired |
GET | ID of race. | uint |
|
api_keyRequired |
GET | Race API key. | string |
|
api_secretRequired |
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 |
|
sort |
GET | Sort by “created_ts”, “last_modified_ts”, “race_fundraiser_id”, or “amount_raised”. | string |
|
sort_direction |
GET | ASC | Sort direction. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Get Fundraisers for Races",
"description": "Get list of race fundraisers.",
"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 Fundraisers",
"description": "APIs related to Race Fundraisers"
}
],
"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"
}
]
},
"V2RaceFundraisersGetRaceFundraisersGetResponse": {
"type": "object",
"title": "Race Fundraisers Response",
"description": "Response containing list of race fundraisers. Additional fields are included based on request parameters.",
"properties": {
"race_fundraisers": {
"type": "array",
"description": "List of race fundraisers. The response includes additional fields when certain parameters are set to true.",
"items": {
"type": "object",
"description": "Details about a race fundraiser",
"properties": {
"race_fundraiser_id": {
"type": "integer",
"description": "Unique identifier for the race fundraiser"
},
"race_fundraiser_name": {
"type": "string",
"description": "Name of the race fundraiser"
},
"parent_fundraiser_id": {
"type": "integer",
"description": "ID of the parent fundraiser if this is a child fundraiser"
},
"created_ts": {
"type": "string",
"description": "Timestamp when the fundraiser was created",
"format": "date-time"
},
"registration_id": {
"type": "integer",
"description": "Associated registration ID"
},
"is_team_fundraiser": {
"type": "boolean",
"description": "Whether this is a team fundraiser"
},
"fundraiser_hidden": {
"type": "boolean",
"description": "Whether the fundraiser is hidden"
},
"fundraiser_url": {
"type": "string",
"description": "Public URL for the fundraiser"
},
"fundraiser_token": {
"type": "string",
"description": "Unique token for the fundraiser"
},
"fundraiser_owner": {
"type": "object",
"description": "Information about the fundraiser owner",
"properties": {
"user_id": {
"type": "integer",
"description": "User ID of the fundraiser owner"
},
"first_name": {
"type": "string",
"description": "First name of the fundraiser owner"
},
"last_name": {
"type": "string",
"description": "Last name of the fundraiser owner"
},
"email": {
"type": "string",
"description": "Email address of the fundraiser owner"
},
"phone_number": {
"type": "string",
"description": "Phone number of the fundraiser owner"
}
},
"required": [
"user_id",
"first_name",
"last_name",
"email",
"phone_number"
]
},
"charity_id": {
"type": "integer",
"description": "ID of the associated charity"
},
"charity_name": {
"type": "string",
"description": "Name of the associated charity"
},
"fundraiser_tagline": {
"type": "string",
"description": "Tagline for the fundraiser"
},
"personal_message": {
"type": "string",
"description": "Personal message from the fundraiser"
},
"fundraising_goal": {
"type": "number",
"description": "Fundraising goal amount"
},
"fundraising_minimum": {
"type": "number",
"description": "Minimum fundraising amount required"
},
"donation_period_id": {
"type": "integer",
"description": "ID of the donation period"
},
"applied_for_refund": {
"type": "boolean",
"description": "Whether a refund has been applied for"
},
"last_modified_ts": {
"type": "string",
"description": "Timestamp of last modification",
"format": "date-time"
},
"last_modified_or_donation_amount_change_ts": {
"type": "string",
"description": "Timestamp of last modification or donation amount change",
"format": "date-time"
},
"amount_raised": {
"type": "number",
"description": "Total amount raised by the fundraiser. Present when include_amount_raised=T",
"x-response-field-inclusion": {
"request-parameter": "include_amount_raised",
"value": "T"
}
},
"number_of_donations": {
"type": "integer",
"description": "Number of donations received. Present when include_number_of_donations=T",
"x-response-field-inclusion": {
"request-parameter": "include_number_of_donations",
"value": "T"
}
},
"fundraiser_primary_image_filename": {
"type": "string",
"description": "URL to the fundraiser's primary image. Present when include_fundraiser_profile_images=T",
"x-response-field-inclusion": {
"request-parameter": "include_fundraiser_profile_images",
"value": "T"
}
},
"team_fundraiser_type_id": {
"type": "integer",
"description": "ID of the team fundraiser type. Present when include_fundraiser_type_info=T",
"x-response-field-inclusion": {
"request-parameter": "include_fundraiser_type_info",
"value": "T"
}
},
"team_fundraiser_type": {
"type": "object",
"description": "Team fundraiser type details. Present when include_fundraiser_type_info=T",
"x-response-field-inclusion": {
"request-parameter": "include_fundraiser_type_info",
"value": "T"
},
"properties": {
"id": {
"type": "integer",
"description": "ID of the team fundraiser type"
},
"name": {
"type": "string",
"description": "Name of the team fundraiser type"
},
"description": {
"type": "string",
"description": "Description of the team fundraiser type"
}
},
"required": [
"id",
"name",
"description"
]
},
"umbrella_team_id": {
"type": "integer",
"description": "ID of the umbrella team. Present when include_umbrella_teams=T",
"x-response-field-inclusion": {
"request-parameter": "include_umbrella_teams",
"value": "T"
}
},
"umbrella_team_name": {
"type": "string",
"description": "Name of the umbrella team. Present when include_umbrella_teams=T",
"x-response-field-inclusion": {
"request-parameter": "include_umbrella_teams",
"value": "T"
}
},
"external_fundraiser_id": {
"type": "string",
"description": "External fundraiser ID. Present when include_external_fundraiser_ids=T",
"x-response-field-inclusion": {
"request-parameter": "include_external_fundraiser_ids",
"value": "T"
}
},
"minimum_commitment_level_id": {
"type": "integer",
"description": "ID of the minimum commitment level. Present when include_minimum_commitment_data=T",
"x-response-field-inclusion": {
"request-parameter": "include_minimum_commitment_data",
"value": "T"
}
},
"minimum_commitment_level_name": {
"type": "string",
"description": "Name of the minimum commitment level. Present when include_minimum_commitment_data=T",
"x-response-field-inclusion": {
"request-parameter": "include_minimum_commitment_data",
"value": "T"
}
},
"minimum_commitment_level_amount": {
"type": "number",
"description": "Amount of the minimum commitment level. Present when include_minimum_commitment_data=T",
"x-response-field-inclusion": {
"request-parameter": "include_minimum_commitment_data",
"value": "T"
}
}
},
"required": [
"race_fundraiser_id",
"race_fundraiser_name",
"parent_fundraiser_id",
"created_ts",
"registration_id",
"is_team_fundraiser",
"fundraiser_hidden",
"fundraiser_url",
"fundraiser_token",
"fundraiser_owner",
"charity_id",
"charity_name",
"fundraiser_tagline",
"personal_message",
"fundraising_goal",
"fundraising_minimum",
"donation_period_id",
"applied_for_refund",
"last_modified_ts",
"last_modified_or_donation_amount_change_ts"
]
}
}
},
"required": [
"race_fundraisers"
],
"example": {
"race_fundraisers": [
{
"race_fundraiser_id": 123,
"race_fundraiser_name": "Some Fundraiser Name",
"parent_fundraiser_id": 567,
"created_ts": "01/01/2023 12:00",
"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,
"fundraising_minimum": 250,
"amount_raised": 250,
"donation_period_id": 1,
"applied_for_refund": "F",
"last_modified_ts": "01/15/2023 15:30",
"last_modified_or_donation_amount_change_ts": "01/15/2023 15:30",
"number_of_donations": 3,
"fundraiser_primary_image_filename": "/path/to/image.png",
"team_fundraiser_type_id": 1,
"team_fundraiser_type": {
"id": 1,
"name": "Corporate",
"description": "Corporate team fundraiser"
},
"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
}
]
}
}
},
"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": {
"/v2/race-fundraisers/get-race-fundraisers.json": {
"get": {
"tags": [
"Race Fundraisers"
],
"summary": "Get Fundraisers for Races",
"description": "Get list of race fundraisers.",
"operationId": "v2_race_fundraisers_get_race_fundraisers_json",
"parameters": [
{
"name": "race_id",
"in": "query",
"description": "ID of race.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "api_key",
"in": "query",
"description": "Race API key.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "api_secret",
"in": "query",
"description": "Race API secret.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "donation_period_id",
"in": "query",
"description": "Get fundraisers associated with a donation period ID.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "num",
"in": "query",
"description": "Number of results per page. The allowed range per page is from 1 - 500, outside this range it defaults to 50 per page.",
"required": false,
"schema": {
"type": "integer",
"default": "50"
}
},
{
"name": "page",
"in": "query",
"description": "Number of pages.",
"required": false,
"schema": {
"type": "integer",
"default": "1"
}
},
{
"name": "modified_after_ts",
"in": "query",
"description": "Get fundraisers updated after the provided timestamp.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "modified_before_ts",
"in": "query",
"description": "Get fundraisers updated before the provided timestamp.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "include_amount_raised",
"in": "query",
"description": "Get amount raised for fundraisers?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "modified_field",
"in": "query",
"description": "Consider only metadata changes or metadata and donation amount changes? Allowed values are 'meta' or 'meta_or_donation'.",
"required": false,
"schema": {
"type": "string",
"default": "meta"
}
},
{
"name": "include_number_of_donations",
"in": "query",
"description": "Include number of donations.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_fundraiser_profile_images",
"in": "query",
"description": "Include fundraiser profile image.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "included_fundraiser_types",
"in": "query",
"description": "Include fundraisers types. Allowed values: 'any', 'individuals', 'teams'",
"required": false,
"schema": {
"type": "string",
"default": "any"
}
},
{
"name": "include_fundraiser_type_info",
"in": "query",
"description": "Include team fundraiser type info.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_umbrella_teams",
"in": "query",
"description": "Include umbrella team info.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_import_data",
"in": "query",
"description": "(Deprecated: Use `include_external_fundraiser_ids` instead.) Include external fundraiser info.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_external_fundraiser_ids",
"in": "query",
"description": "Include external fundraiser info.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "include_minimum_commitment_data",
"in": "query",
"description": "Include minimum commitment info.",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "registration_id",
"in": "query",
"description": "Get fundraiser associated with a registration ID.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fundraiser_id",
"in": "query",
"description": "Get fundraiser associated with a fundraiser ID.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sort",
"in": "query",
"description": "Sort by \u201ccreated_ts\u201d, \u201clast_modified_ts\u201d, \u201crace_fundraiser_id\u201d, or \u201camount_raised\u201d.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"description": "Sort direction.",
"required": false,
"schema": {
"type": "string",
"default": "ASC"
}
}
],
"security": [
{
"apiKey": []
},
{
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Race Fundraisers Response - Response containing list of race fundraisers. Additional fields are included based on request parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2RaceFundraisersGetRaceFundraisersGetResponse"
}
}
}
},
"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"
]
}
}
}
}
