Skip to main content
GET
/
v1
/
campaigns
/
{campaign}
Get a campaign
curl --request GET \
  --url https://api.givebutter.com/v1/campaigns/{campaign} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
campaign
integer
required

The campaign ID

Response

CampaignResource

​
id
string
required
​
code
string
required
​
account_id
string
required
​
event_id
string
required
​
type
string
required
​
title
string
required
​
subtitle
string
required
​
description
string
required
​
slug
string
required
​
url
string
required
​
goal
integer | null
required
​
raised
number
required
​
donors
integer
required
​
currency
string
required
​
cover
string
required
​
status
string
required
​
timezone
string
required
​
end_at
string
required
​
settings
CampaignSettingResource · object[]
required
​
created_at
string
required
​
updated_at
string
required
​
event
EventResource · object