Sign in

d22bb925eeed

latestOpenAPI 3.0.02026-08-062903562.2 MB
Fundraising Team

listCampaignFundraisingTeams

Retrieves a list of all Fundraising Teams for the specified Campaign

get/campaigns/{campaign}/fundraising-teams

Path parameters

campaigninteger required
Example:227362

Primary identifier of specified Campaign

Query parameters

withstring[]

Request specific relationships to be returned with the FundraisingTeam

[
  "campaign"
]
fields'campaign_id' | 'city' | 'country' | 'cover_photo_id' | 'cover_photo_url' | 'created_at' | 'currency_code' | 'description' | 'goal' | 'id' | 'logo_id' | 'logo_url' | 'name' | 'organization_id' | 'parent_id' | 'postal_code' | 'raw_currency_code' | 'raw_goal' | 'root_id' | 'state' | 'status' | 'team_lead_id' | 'team_lead_supporter_id' | 'thank_you_text' | 'updated_at' | 'canonical_url' | 'designation_id' | 'team_policy_id'
Example:id

Comma-separated list of fields to be returned.

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

{host}/campaigns/227362/fundraising-teams?page=1

next_page_urlstring nullable

URL of next page of results

pathstring nullable

{host}/campaigns/227362/fundraising-teams

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": [
    {
      "campaign_id": 227362,
      "city": "San Diego",
      "country": "US",
      "cover_photo_id": 1145,
      "cover_photo_url": "https://gofundme-cdn-url.com/your-cover-photo.png",
      "created_at": "2021-04-23T08:23:21Z",
      "currency_code": "USD",
      "description": "My team description",
      "goal": 108.23,
      "id": 209745,
      "logo_id": 1145,
      "logo_url": "https://gofundme-cdn-url.com/your-cover-photo.png",
      "name": "My Team",
      "organization_id": 82364,
      "parent_id": 209750,
      "postal_code": "90210",
      "raw_currency_code": "EUR",
      "raw_goal": "100",
      "root_id": 3345,
      "state": "CA",
      "status": "active",
      "team_lead_id": 2012,
      "team_lead_supporter_id": 7845,
      "thank_you_text": "Thank you!",
      "updated_at": "2021-04-23T10:25:03Z",
      "canonical_url": "/team/10",
      "designation_id": 34672,
      "team_policy_id": 2354
    }
  ],
  "first_page_url": "{host}/campaigns/227362/fundraising-teams?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://pro.gofundme.com/api/2.0/resource?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "https://pro.gofundme.com/api/2.0/resource",
  "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
}