Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Donation Matching Plan

listCampaignDonationMatchingPlans

Retrieves a list of all Donation Matching Plans for specified Campaign

get/campaigns/{campaign}/donation-matching-plans

Path parameters

campaigninteger required
Example:227362

Primary identifier of Donation Matching Plan

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/donation-matching-plans?page=1

next_page_urlstring nullable

URL of next page of results

pathstring nullable

{host}/campaigns/227362/donation-matching-plans

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": [
    {
      "id": 23847,
      "campaign_id": 227362,
      "currency_code": "USD",
      "matching_limit_amount": 5000,
      "started_at": "2021-04-23T10:25:03Z",
      "ended_at": "2021-04-24T10:25:03Z",
      "business_name": "Sponsor Name",
      "timezone_identifier": "Europe/Paris",
      "matched_amount": 4200,
      "asset_id": 1145,
      "created_at": "2021-04-23T08:23:21Z",
      "updated_at": "2021-04-23T10:25:03Z"
    }
  ],
  "first_page_url": "{host}/campaigns/227362/donation-matching-plans?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
}