Returns a list of fundraisers with their names, team type, and donation amounts sorted by donation amount in descending order.
{
"race_fundraisers": [{
"race_fundraiser_id": 4903,
"race_donation_period_id": 2237,
"fundraiser_name": "Team A",
"fundraiser_type": "Charity",
"is_team_fundraiser": "T",
"displayed_donation_amount": "$725.00"
}, {
"race_fundraiser_id": 4961,
"race_donation_period_id": 2237,
"fundraiser_name": "Jane Doe",
"fundraiser_type": "Business",
"is_team_fundraiser": "F",
"displayed_donation_amount": "$350.00"
}]
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
race_idRequired |
GET | ID of race. | uint |
|
donation_period_id |
GET | Get fundraisers associated with a donation period ID. | uint |
|
api_key |
GET | Race API key. | string |
|
api_secret |
GET | Race API secret. | string |
|
rsu_api_key |
GET | API key. | string |
|
X-RSU-API-SECRET |
HTTP Header | API secret. | string |
|
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 |
{
"openapi": "3.0.3",
"info": {
"title": "Get Fundraiser Donation Amounts",
"description": "Get list of race fundraisers with their donation amounts in descending order.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://api.runsignup.com/rest",
"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"
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": true
}
},
"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": {
"/v2/race-fundraisers/get-race-fundraisers-donation-amount.json": {
"get": {
"tags": [
"Race Fundraisers"
],
"summary": "Get Fundraiser Donation Amounts",
"description": "Get list of race fundraisers with their donation amounts in descending order.",
"operationId": "v2_race_fundraisers_get_race_fundraisers_donation_amount_json",
"parameters": [
{
"name": "race_id",
"in": "query",
"description": "ID of race.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "donation_period_id",
"in": "query",
"description": "Get fundraisers associated with a donation period ID.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "api_key",
"in": "query",
"description": "Race API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "api_secret",
"in": "query",
"description": "Race API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "rsu_api_key",
"in": "query",
"description": "API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-SECRET",
"in": "header",
"description": "API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"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"
}
}
],
"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": [
"affiliates",
"partners",
"race_directors",
"timers"
]
}
}
}
}
