/gofundme/campaigns

POST /api/gofundme/campaigns

Price: 20 credits

Get GoFundMe campaign (fundraiser) details by slug or URL

How to use it

Get full details of a GoFundMe campaign (fundraiser) by slug or URL. Returns the goal and raised amount with currency, donation/heart/comment/update counts, category, the full story text and summary, cover image and gallery, organizer and beneficiary, charity/nonprofit record (name, EIN, location) when the campaign is charity-organized, the goal-change history, team members, and location.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• campaign string required — Campaign slug ('help-ben-fight-cancer') or full URL (examples: "help-ben-fight-cancer", "https://www.gofundme.com/f/help-ben-fight-cancer"; minLength: 1)

Response

• @type string (default: "GofundmeCampaign")
• id string required
• alias string required
• url string required
• campaign_title string required
• description string nullable
• story_summary string nullable
• image string nullable
• images array (default: [])
• youtube_url string nullable
• currency string nullable
• goal_amount number nullable
• user_defined_goal_amount number nullable
• current_amount number nullable
• donation_count integer nullable
• heart_count integer nullable
• comment_count integer nullable
• share_count integer nullable
• update_count integer nullable
• category_id integer nullable
• project_type string nullable
• status string nullable
• is_charity boolean nullable
• is_personal_charity boolean nullable
• comments_enabled boolean nullable
• donations_enabled boolean nullable
• suggested_donation_amount number nullable
• created_at integer nullable
• published_at integer nullable
• location object nullable
  • @type string (default: "GofundmeLocation")
  • city string nullable
  • state string nullable
  • country string nullable
  • postal_code string nullable
  • text string nullable
• organizer object nullable
  • @type string (default: "GofundmeUser")
  • id string nullable
  • first_name string nullable
  • last_name string nullable
  • profile_url string nullable
• beneficiary object nullable
  • @type string (default: "GofundmeUser")
  • id string nullable
  • first_name string nullable
  • last_name string nullable
  • profile_url string nullable
• charity object nullable
  • @type string (default: "GofundmeCharity")
  • id string nullable
  • npo_id string nullable
  • ein string nullable
  • name string nullable
  • city string nullable
  • state string nullable
  • country string nullable
  • alias string nullable
  • status string nullable
  • image string nullable
  • verified_at integer nullable
• donation_configuration object nullable
  • @type string (default: "GofundmeDonationConfiguration")
  • payment_methods array (default: [])
  • payment_processor string nullable
• team object nullable
  • @type string (default: "GofundmeTeam")
  • name string nullable
  • status string nullable
  • created_at integer nullable
• team_members array (default: [])
  • @type string (default: "GofundmeTeamMember")
  • id string nullable
  • name string nullable
  • first_name string nullable
  • last_name string nullable
  • role string nullable
  • status string nullable
  • amount_raised number nullable
  • donation_count integer nullable
  • profile_url string nullable
• goal_log array (default: [])
  • @type string (default: "GofundmeGoal")
  • amount number nullable
  • currency string nullable
  • source string nullable
  • changed_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Campaign not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.