Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Supporter

listCampaignSupporters

Retrieves a list of all Supporters for a specific Campaign

get/campaigns/{campaign}/supporters

Path parameters

campaigninteger required
Example:227362

The specified Campaign ID

Query parameters

pageinteger
Example:1

Indicator of which page of results to return

per_pageinteger
Example:20

Number of entries to return in each page of results

Response

Success

current_pageinteger

Index of current page

first_page_urlstring nullable

URL of first page of results

frominteger nullable

Index of first displayed result within total result set

last_pageinteger

Index of last page in result set

last_page_urlstring nullable

URL of last page of results

next_page_urlstring nullable

URL of next page of results

pathstring nullable

URL of current page of results

per_pageinteger

Maximum number of records returned per page of results

prev_page_urlstring nullable

URL of previous page of results

tointeger nullable

Index of last displayed result within total result set

totalinteger

Total count of records in result set

Example response

{
  "current_page": 1,
  "data": [
    {
      "address1": "300 N Washington St",
      "address2": "300 N Washington St",
      "birthday": "3/15",
      "cell_phone": "619-555-1212",
      "city": "Gettysburg",
      "country": "US",
      "created_at": "2021-04-23T08:23:21Z",
      "email_address": "test@gofundme.com",
      "first_name": "Hannah",
      "gender": "M",
      "id": 5827,
      "last_emailed_at": "test@gofundme.com",
      "last_name": "Rosendo",
      "location": "City Townhall",
      "member_id": 2012,
      "metadata": {
        "foo": "bar"
      },
      "nickname": "GoFundMePro",
      "opt_in": true,
      "origin": "donation",
      "phone": "619-555-1212",
      "postal_code": "92101",
      "source_campaign_id": 227362,
      "source_fundraising_page_id": 2173528,
      "source_member_id": 2012,
      "source_organization_id": 82364,
      "state": "NE",
      "updated_at": "2021-04-23T08:23:21Z"
    }
  ],
  "first_page_url": "{host}/campaigns/{campaign}/supporters?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "{host}/campaigns/{campaign}/supporters?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "{host}/campaigns/{campaign}/supporters",
  "per_page": 20,
  "prev_page_url": "https://pro.gofundme.com/api/2.0/resource?page=1",
  "links": [
    {
      "label": "1",
      "url": "{host}/{resource}?page=1",
      "active": true
    }
  ],
  "to": 1,
  "total": 1
}