Skip to main content
GET
/
v1
/
pledges
/
{pledge}
Get a pledge
curl --request GET \
  --url https://api.givebutter.com/v1/pledges/{pledge} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "contact_id": "<string>",
  "campaign_id": "<string>",
  "fund_id": "<string>",
  "type": "<string>",
  "status": "<string>",
  "status_friendly": "<string>",
  "amount": "<string>",
  "amount_fulfilled": "<string>",
  "amount_remaining": "<string>",
  "allow_custom_amount": "<string>",
  "installment_frequency": "<string>",
  "first_installment_date": "<string>",
  "next_installment_date": "<string>",
  "expected_fulfillment_date": "<string>",
  "memo": "<string>",
  "auto_remind": "<string>",
  "last_reminded_at": "<string>",
  "fee_coverage_type": "<string>",
  "fee_coverage_visibility": "<string>",
  "include_in_campaign_goal": "<string>",
  "tips_enabled": "<string>",
  "canceled_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.givebutter.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
pledge
integer
required

The pledge ID

Response

PledgeResource

​
id
string
required
​
contact_id
string
required
​
campaign_id
string
required
​
fund_id
string
required
​
type
string
required
​
status
string
required
​
status_friendly
string
required
​
amount
string
required
​
amount_fulfilled
string
required
​
amount_remaining
string
required
​
allow_custom_amount
string
required
​
installment_frequency
string
required
​
first_installment_date
string
required
​
next_installment_date
string
required
​
expected_fulfillment_date
string
required
​
memo
string
required
​
auto_remind
string
required
​
last_reminded_at
string
required
​
fee_coverage_type
string
required
​
fee_coverage_visibility
string
required
​
include_in_campaign_goal
string
required
​
tips_enabled
string
required
​
canceled_at
string
required
​
created_at
string
required
​
updated_at
string
required