Skip to main content
GET
/
campaigns
Retrieve a list of campaigns
curl --request GET \
  --url https://api.givebutter.com/v1/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "code": "<string>",
      "account_id": "<string>",
      "event_id": "<string>",
      "type": "<string>",
      "title": "<string>",
      "subtitle": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "url": "<string>",
      "goal": 123,
      "raised": 123,
      "donors": 123,
      "currency": "<string>",
      "cover": "<string>",
      "status": "<string>",
      "timezone": "<string>",
      "end_at": "<string>",
      "settings": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "event": {
        "title": "<string>",
        "type": "<string>",
        "location_name": "<string>",
        "address_formatted": "<string>",
        "google_place_id": "<string>",
        "start_at": "<string>",
        "end_at": "<string>",
        "timezone": "<string>",
        "details": "<string>",
        "private": "<string>",
        "tickets_required": "<string>",
        "livestream": "<string>",
        "livestream_start_at": "<string>",
        "livestream_end_at": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1,
    "unfiltered_total": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

scope
string

Response

200 - application/json

Paginated set of CampaignResource

data
CampaignResource · object[]
required
meta
object
required