Attribute | Description |
id | The campaign ID. |
type | The type of the campaign. Possible values: |
title | The title of the campaign. |
subtitle | The subtitle of the campaign. |
description | The HTML content displayed as the description of the campaign. |
slug | The slug to be used for this campaign. Must be unique across Givebutter. |
goal | The campaign goal. |
raised | The amount of money raised for this campaign. |
donors | The number of donors who gave to this campaign. |
end_at | A UTC datetime string indicating when the campaign ends. |
url | The full URL of this campaign. |
currency | The currency of this campaign (currently only USD is supported). |
logo | URL to the logo for the campaign. |
cover | An object representing the cover photo / banner of this campaign. |
created_at | A UTC datetime string indicating when the campaign was created. |
updated_at | A UTC datetime string indicating when the campaign was last updated. |
meta | An object representing the meta tags of this campaign (includes title, description, and image). |
account_id | The ID for the account that owns this campaign. |
null
to retrieve only your account's campaigns.
benefiting
to retrieve campaigns of which you are the beneficiary.
chapters
to retrieve campaigns owned by chapters under your account.
all
to retrieve all campaigns related to your account.{"id": 123,"account_id": "tFojY6OML6xZF521","type": "collect","title": "Giving Tuesday Fundraising Campaign","subtitle": null,"description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>","slug": "74XqKK","url": "https://givebutter.com/example","goal": 10000,"raised": 4013,"donors": 591,"currency": "USD","logo": "https://givebutter.com/...","cover": {"type": "image","url": "https://givebutter.com/...","source": "upload"},"end_at": null,"created_at": "2020-05-05 04:26:31","updated_at": "2020-05-15 16:57:47"}
This endpoint returns only campaigns created under your account by default. If your account has campaigns of which you are the beneficiary, or campaigns owned by chapter accounts, you'll need to change the scope parameter to the appropriate value.
2019-01-01 20:30:00
collect
, fundraise
, event
.{"id": 123,"account_id": "tFojY6OML6xZF521","type": "collect","title": "Giving Tuesday Fundraising Campaign","subtitle": null,"description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>","slug": "74XqKK","url": "https://givebutter.com/example","goal": 10000,"raised": 4013,"donors": 591,"currency": "USD","logo": "https://givebutter.com/...","cover": {"type": "image","url": "https://givebutter.com/...","source": "upload"},"end_at": null,"created_at": "2020-05-05 04:26:31","updated_at": "2020-05-15 16:57:47"}
Please ensure you are selecting the correct campaign type, as this effects the pricing tier of the campaign. See our website for more details.
{"id": 123,"account_id": "tFojY6OML6xZF521","type": "collect","title": "Giving Tuesday Fundraising Campaign","subtitle": null,"description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>","slug": "74XqKK","url": "https://givebutter.com/example","goal": 10000,"raised": 4013,"donors": 591,"currency": "USD","logo": "https://givebutter.com/...","cover": {"type": "image","url": "https://givebutter.com/...","source": "upload"},"end_at": null,"created_at": "2020-05-05 04:26:31","updated_at": "2020-05-15 16:57:47"}
​
You can not delete campaigns that have already raised money, doing so will result in an error. If you need to delete a campaign that has already raised money, please contact us.