Use this API to get all donation forms within a donation website.
{
"donation_forms": [
{
"donation_form_id": 123,
"donation_form_name": "Example Donation Form",
"donation_form_url": "https://www.givesignup.org/g/000000",
"donations_accepted_start_date_ts": 1624334400,
"donations_accepted_end_date_ts": 1634788799,
"enable_donation_dedication": "F",
"donation_dedication_text": null,
"donation_levels": [
{
"donation_level_text": "Bronze",
"donation_level_details": null,
"min_donation_amount_in_cents": 500
},
{
"donation_level_text": "Silver",
"donation_level_details": null,
"min_donation_amount_in_cents": 1500
},
{
"donation_level_text": "Gold",
"donation_level_details": null,
"min_donation_amount_in_cents": 5000
}
],
"donation_messaging": {
"donation_description_html": "Example donation messaging
",
"donation_description_text": "Example donation messaging",
"donations_closed_html": null,
"offline_payment_instructions": null,
"absorb_processing_fee_text": null
},
"donation_use_designations": [
{
"donation_designation_short_text": "Education",
"donation_designation_long_text": "Help with education."
},
{
"donation_designation_short_text": "Housing",
"donation_designation_long_text": "Help with housing."
}
]
}
]
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
donation_website_idRequired |
GET | Donation Website ID | uint |
|
rsu_api_keyRequired |
GET | API key | string |
|
X-RSU-API-SECRETRequired |
HTTP Header | API secret | string |
{
"openapi": "3.0.3",
"info": {
"title": "Get Donation Forms",
"description": "Get all donation forms within a donation website.",
"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": "Donation Websites",
"description": "APIs related to Donation Websites"
}
],
"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/donation-websites/get-donation-forms.json": {
"get": {
"tags": [
"Donation Websites"
],
"summary": "Get Donation Forms",
"description": "Get all donation forms within a donation website.",
"operationId": "v2_donation_websites_get_donation_forms_json",
"parameters": [
{
"name": "donation_website_id",
"in": "query",
"description": "Donation Website ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "rsu_api_key",
"in": "query",
"description": "API key",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-SECRET",
"in": "header",
"description": "API secret",
"required": true,
"schema": {
"type": "string"
}
}
],
"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": []
}
}
}
}
