Fundraising Event List ⇄ Details
GET https://api.betterplace.org/de/api_v4/fundraising_events.json?facets=closed%3Afalse&order=rank%3ADESC&q=Die+Eckerts&scope=locationA list of betterplace.org fundraising events (donate money). Results are contained in a data attribute.
For betterplace.org clients:
Use this resource as follows: /clients/PERMALINK/fundraising-events.json.
To guarantee stable search results, all clients are required to specify at least one facet and order with each request as explained below.
| Parameter | Example | Required | Description |
|---|---|---|---|
| scope | location |
no |
Use the scope to specify how the search-query
|
| q | Die Eckerts |
no |
Search query. The searches behaviour is based on the scope. |
| facets | closed:false |
no |
Filter the result set.
|
| order | rank:DESC |
no |
Order the result set.
|
| Attribute | Types | Example | Description |
|---|---|---|---|
| id | number |
1 |
An integer number ≥ 1 |
| created_at | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone) |
| updated_at | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone) |
| content_updated_at | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone) |
| title | string |
Gemeinsam gegen Ebola: Deine Spende für Westafrika |
Max 50 character |
| description | string |
Lorem ipsum |
A description of the fundraising event. This may contain any of the
following HTML tags: |
| tax_deductible | boolean |
true |
This value is deprecated and will be removed. |
| donations_prohibited | boolean |
false |
True if the fundraising event must not and cannot receive donations. This might happen if the event was closed by the manager, blocked by a platform administrator or the donation activation time is in the future. Please check this flag whenever you display a donation button. Should you show a button for an event that cannot receive donations the user will open the donation form and see an error message on betterplace.org instead! |
| closed_at | null | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone) when the fundraising event was closed by the manager. |
| activate_donations_at | null | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone). Donations are prohibited until this date and time is reached. Defaults to NULL. |
| donations_count | number |
42 |
Count of confirmed donations for this fundraising event |
| donor_count | number |
46 |
Number of unique donors, based on the payment-email-address |
| donated_amount_in_cents | number |
232323 |
How many cents were already raised with the fundraising event |
| requested_amount_in_cents | null | number |
12382 |
How many cents were requested to be raised with the fundraising event. This value is optional! The manager decides if his event has a goal or not. |
| forwarded_amount_in_cents | number |
12382 |
How many cents were already forwarded to a project. |
| progress_percentage | null | number |
5 |
% financed. This value is only present in case the manager
decided to add a |
| ↓contact | object |
TODO |
The public face of the fundraising event / fundraising event manager |
| ↓profile_picture | null | object |
//betterplace-assets.betterplace.org ↪/uploads/user/profile_picture ↪/000/000/001 ↪/fill_100x100_original_tb.jpg |
TODO |
| Attribute | Types | Example | Description |
|---|---|---|---|
| contact.id | number |
1 |
An integer number ≥ 1 |
| contact.name | null | string |
"Till B." |
Display name of a betterplace.org user. Possible formats: "Till B.", "T. Behnke", "Till Behnke". In the case of donation-opinions the name might also be empty/null for anonymous donations for anonymous donations. |
| ↓contact.picture | object |
//betterplace-assets.betterplace.org ↪/uploads/user/profile_picture ↪/000/000/001 ↪/fill_100x100_original_tb.jpg |
User profile picture or a fallback image |
| Attribute | Types | Example | Description |
|---|---|---|---|
| contact.picture.fallback | boolean |
true |
Specifies whether a fallback image is given or not |
| Attribute | Types | Example | Description |
|---|---|---|---|
| profile_picture.fallback | boolean |
true |
Specifies whether a fallback image is given or not |
| Linkname | Description |
|---|---|
|
self |
Link to this resource itself (fundraising event details) |
|
featured_projects |
A list of projects are currently supported by the fundraising event. Please note that this project list has no fixed relation to the list of projects that received money by this fundraising event (see Featured Projects List). A Fundraising event manager can change the list of supported projects at any time; regardless if they received money before. |
|
blog_posts |
Link to blog posts list |
|
forwardings |
Provides a list of forwarded amounts and their receiving projects. Each fundraising event can have multiple projects that it supports. The fundraising event manager specifies the amount that is forwarded from the fundraising event to the project. Please note that this list of forwarded donations and their corresponding receiving projects is not required to be in sync with the Featured Project List endpoint. To find out if all donations of the fundraising event have been forwarded, please sum the amounts provided by this api endpoint and compare it to the donated amount attribute of the fundraising event api endpoint. |
|
platform |
Permalink to betterplace.org |
|
opinions |
Link to donations/opinions list |
|
new_client_donation |
Link to the donation form. Templated, needs insertion of the client_id. |
|
new_donation |
Link to the regular donation form. |
|
header_picture |
Optional additional image to be used when promoting the fundraising event. This is an experimental feature. Please use it with caution. We might change or remove it any time without notice. |
|
new_message |
Send message to this fundraising event via betterplace.org |
|
contact.platform |
The user's profile on betterplace.org. To view a user profile you have to be logged in. This array is empty if the user has no useraccount with betterplace.org but donated via one of our partner. |
|
contact.contact_data |
The user's contact data. Please note that you need to be authenticated as a client with matching access rights in order to see this information. |
|
contact.picture.fill_100x100 |
100×100 Pixel |
|
contact.picture.original |
Maximum sized image. This is the original image with default-cropping or user-cropping applied. |
|
profile_picture.fill_960x500 |
950×500 Pixel |
|
profile_picture.fill_730x380 |
730×380 Pixel |
|
profile_picture.fill_618x322 |
618×322 Pixel / DEPRECATED, will be removed after 5/2015 |
|
profile_picture.fill_410x214 |
410×214 Pixel |
|
profile_picture.fill_270x141 |
270×141 Pixel / DEPRECATED, will be removed after 5/2015 |
|
profile_picture.original |
Maximum sized image. This is the original image with default-cropping or user-cropping applied. |
{
"total_entries": 5,
"offset": 0,
"total_pages": 2,
"current_page": 1,
"per_page": 3,
"data": [
{
"id": 39294,
"created_at": "2021-09-26T23:25:57+02:00",
"updated_at": "2021-10-09T19:25:08+02:00",
"content_updated_at": "2021-10-09T19:25:08+02:00",
"title": "My birthday stream",
"description": "<div>Do we want to do something really good together? How about supporting together via this fundraiser \"Tree by tree for our climate - plant rainforest trees!\" from OroVerde - The Tropical Forest Foundation? I chose this organization because their work is very close to my heart. Both I and OroVerde - The Tropical Forest Foundation appreciate your support, because really every contribution helps!<br><br>Why do I use betterplace.org for this? Donating here is safe and uncomplicated and I can keep you informed about updates. Of course you will get a donation receipt for tax purposes at the beginning of next year.<br><br>\n</div>",
"tax_deductible": true,
"donations_prohibited": false,
"closed_at": null,
"activate_donations_at": null,
"donations_count": 0,
"donor_count": 0,
"donated_amount_in_cents": 0,
"requested_amount_in_cents": null,
"forwarded_amount_in_cents": 0,
"progress_percentage": null,
"contact": {
"id": 593528,
"name": "Elijah Lange (display)",
"picture": {
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/593/528/fill_100x100_bp1615732713_Stitch.png"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/593/528/crop_original_bp1615732713_Stitch.png"
}
]
},
"links": [
{
"rel": "platform",
"href": "https://www.betterplace.org/de/users/593528"
},
{
"rel": "contact_data",
"href": "https://api.betterplace.org/de/api_v4/users/593528/contact_data.json"
}
]
},
"profile_picture": {
"fallback": true,
"links": [
{
"rel": "fill_960x500",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_960x500_birthday_default.png"
},
{
"rel": "fill_730x380",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_730x380_birthday_default.png"
},
{
"rel": "fill_618x322",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_618x322_birthday_default.png"
},
{
"rel": "fill_410x214",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_410x214_birthday_default.png"
},
{
"rel": "fill_270x141",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_270x141_birthday_default.png"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/crop_original_birthday_default.png"
}
]
},
"links": [
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/39294.json"
},
{
"rel": "featured_projects",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/39294/featured_projects.json"
},
{
"rel": "blog_posts",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/39294/blog_posts.json"
},
{
"rel": "forwardings",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/39294/forwardings.json"
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/fundraising-events/39294-my-birthday-stream"
},
{
"rel": "opinions",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/39294/opinions.json"
},
{
"rel": "new_client_donation",
"href": "https://www.betterplace.org/de/donate/%7Bclient_id%7D/fundraising-events/39294",
"templated": true
},
{
"rel": "new_donation",
"href": "https://www.betterplace.org/de/donate/platform/fundraising-events/39294"
},
{
"rel": "new_message",
"href": "https://www.betterplace.org/de/messages/new?recipient=593528"
}
]
},
{
"id": 40476,
"created_at": "2022-10-20T16:43:47+02:00",
"updated_at": "2022-10-20T17:21:21+02:00",
"content_updated_at": "2022-10-20T16:43:47+02:00",
"title": "FundraisingEventProject test",
"description": "<div>Wollen wir zusammen was richtig Gutes machen? Wie wäre es damit, gemeinsam über diese Spendenaktion „Deine Spende für den SHEROES Fund“ von Amadeu Antonio Stiftung zu unterstützen? Ich habe mir diese Organisation ausgesucht, da mir iadwawadwhre Arbeit sehr am Herzen liegt. Sowohl ich als auch Amadeu Antonio Stiftung freuen uns über deine Unterstützung, denn wirklich jeder Beitrag hilft!<br><br>\n</div><div>Warum ich dafür betterplace.org nutze? Das Spenden ist hier sicher und unkompliziert und ich kann euch über Updates auf dem Laufenden halten. Natürlich bekommt ihr Anfang nächsten Jahres auch eine Spendenbescheinigung für die Steuer.<br><br>\n</div>",
"tax_deductible": true,
"donations_prohibited": false,
"closed_at": null,
"activate_donations_at": null,
"donations_count": 0,
"donor_count": 0,
"donated_amount_in_cents": 0,
"requested_amount_in_cents": 50000,
"forwarded_amount_in_cents": 0,
"progress_percentage": null,
"contact": {
"id": 609657,
"name": "Manuel Hartwig (display)",
"picture": {
"fallback": true,
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/assets/default/user_profile_picture/default.svg"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/assets/default/user_profile_picture/default.svg"
}
]
},
"links": [
{
"rel": "platform",
"href": "https://www.betterplace.org/de/users/609657"
},
{
"rel": "contact_data",
"href": "https://api.betterplace.org/de/api_v4/users/609657/contact_data.json"
}
]
},
"profile_picture": {
"fallback": true,
"links": [
{
"rel": "fill_960x500",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_960x500_birthday_default.png"
},
{
"rel": "fill_730x380",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_730x380_birthday_default.png"
},
{
"rel": "fill_618x322",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_618x322_birthday_default.png"
},
{
"rel": "fill_410x214",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_410x214_birthday_default.png"
},
{
"rel": "fill_270x141",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/fill_270x141_birthday_default.png"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/assets/default/fundraising_event_profile_picture/crop_original_birthday_default.png"
}
]
},
"links": [
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/40476.json"
},
{
"rel": "featured_projects",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/40476/featured_projects.json"
},
{
"rel": "blog_posts",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/40476/blog_posts.json"
},
{
"rel": "forwardings",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/40476/forwardings.json"
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/fundraising-events/40476-fundraisingeventproject-test"
},
{
"rel": "opinions",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/40476/opinions.json"
},
{
"rel": "new_client_donation",
"href": "https://www.betterplace.org/de/donate/%7Bclient_id%7D/fundraising-events/40476",
"templated": true
},
{
"rel": "new_donation",
"href": "https://www.betterplace.org/de/donate/platform/fundraising-events/40476"
},
{
"rel": "new_message",
"href": "https://www.betterplace.org/de/messages/new?recipient=609657"
}
]
},
{
"id": 33831,
"created_at": "2019-12-12T11:20:45+01:00",
"updated_at": "2022-10-25T13:43:37+02:00",
"content_updated_at": "2019-12-12T12:38:12+01:00",
"title": "LPGjustJohnny - Spenden für die letzte Hilfe",
"description": "<div>Durch eigene Erfahrungen habe ich unglaublich Respekt vor Menschen die Hospizdienst, also das Begleiten eines Menschen auf seinem letzten Lebensabschnitt, leisten. Hierfür gibt es Deutschlandweit einige Einrichtungen, die genau auf so etwas spezialisiert sind.<br><br>Der Ansatz von \"Die Pusteblume\" geht aber darüber hinaus und möchte die Menschen in deren gewohnten Umfeld (also meist Zuhause) betreuen. Gerade durch privaten Erlebnisse dieses Jahr kann ich hier einen absoluten Mehrwert erkennen, da Menschen in ihren eigenen vier Wänden ein oftmals würdevolleres Leben und Ende finden können.<br><br>Ich bitte euch herzlichst für diese Idee zu spenden, mit Hilfe euer Spenden soll in erster Linie das Angebot an dich Menschen herangetragen werden - <strong>die Gruppe der Hospizhelfer handelt hierbei ehrenamtlich!<br><br></strong><br>\n</div>",
"tax_deductible": true,
"donations_prohibited": true,
"closed_at": "2021-01-22T08:05:19+01:00",
"activate_donations_at": null,
"donations_count": 61,
"donor_count": 60,
"donated_amount_in_cents": 151850,
"requested_amount_in_cents": 150700,
"forwarded_amount_in_cents": 151850,
"progress_percentage": 100,
"contact": {
"id": 581863,
"name": "Jana Wulf (display)",
"picture": {
"fallback": true,
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/assets/default/user_profile_picture/default.svg"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/assets/default/user_profile_picture/default.svg"
}
]
},
"links": [
{
"rel": "platform",
"href": "https://www.betterplace.org/de/users/581863"
},
{
"rel": "contact_data",
"href": "https://api.betterplace.org/de/api_v4/users/581863/contact_data.json"
}
]
},
"profile_picture": {
"links": [
{
"rel": "fill_960x500",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/033/831/fill_960x500_bp1576146766_Spendenstream.png"
},
{
"rel": "fill_730x380",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/033/831/fill_730x380_bp1576146766_Spendenstream.png"
},
{
"rel": "fill_618x322",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/033/831/fill_618x322_bp1576146766_Spendenstream.png"
},
{
"rel": "fill_410x214",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/033/831/fill_410x214_bp1576146766_Spendenstream.png"
},
{
"rel": "fill_270x141",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/033/831/fill_270x141_bp1576146766_Spendenstream.png"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/033/831/crop_original_bp1576146766_Spendenstream.png"
}
]
},
"links": [
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/33831.json"
},
{
"rel": "featured_projects",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/33831/featured_projects.json"
},
{
"rel": "blog_posts",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/33831/blog_posts.json"
},
{
"rel": "forwardings",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/33831/forwardings.json"
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/fundraising-events/33831-lpgjustjohnny-spenden-fuer-die-letzte-hilfe"
},
{
"rel": "opinions",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/33831/opinions.json"
},
{
"rel": "new_client_donation",
"href": "https://www.betterplace.org/de/donate/%7Bclient_id%7D/fundraising-events/33831",
"templated": true
},
{
"rel": "new_donation",
"href": "https://www.betterplace.org/de/donate/platform/fundraising-events/33831"
},
{
"rel": "new_message",
"href": "https://www.betterplace.org/de/messages/new?recipient=581863"
}
]
}
]
}