API sample apps
Before you start
We recommend that you are familiar with using GoFundMe Pro and understand GoFundMe Pro's data structure. If you are new to GoFundMe Pro, create your first campaign and test adding offline donations to understand how records are created.
Use the GoFundMe Pro API to create data connectors to your organization’s CRM, custom apps for your organization’s website, and much more. Our API examples and sample apps will help you learn how to create custom solutions for your organization.
You don’t need to be a professional developer to use these examples, but it helps if you are comfortable with technical tasks. The level of comfort and skill is recommended on each example:
- Beginner: No development skills or experience is required
- Moderate: Some development experience is helpful
- Advanced: Comfort and experience with development is strongly recommended. For example, running a full-stack application locally and using GitHub.
Examples and sample apps
The examples and sample apps should be used as guides for how to build integrations and applications with our API. They are hosted in GitHub and Postman, and you can refer to each GitHub repository for detailed instructions on how to use them. Review GoFundMe Pro API Samples for links to each sample repository.
Postman examples
Postman is an API platform for developers to build, test, and collaborate on APIs. With our Postman collections, you can request or post GoFundMe Pro records using data from your GoFundMe Pro account or our Mock Server. The Postman collections are meant to be playgrounds that show you how various GoFundMe Pro API calls work.
If you don't have GoFundMe Pro credentials, or would prefer to not make these API calls against your GoFundMe Pro account, you can leverage a Mock Server we've put together as part of this collection.
You do not need any coding experience to try the Postman examples. However, if you don’t have prior experience with Postman, we strongly recommend first following Postman’s Getting Started guide to download Postman and create an account.
Our examples are instructional materials and not finished applications ready for your organization. Always follow best practices and test your application to make sure it works as intended before using it with real data.
The Postman examples include:
- Authentication (Beginner): Test and visualize how to exchange your authentication credentials for an access token. You can use this token for subsequent API requests to GoFundMe Pro.
- Fetch source codes (Beginner): Test and visualize how to retrieve source codes associated with specific transactions, fundraising pages, or fundraising teams. You can also fetch all source codes associated with a campaign or organization's transactions, fundraising pages, and teams.
- Multi-item orders (Beginner): Simplifies transaction reporting by retrieving orders with multiple items on campaigns using Giving Cart.
-
Bulk offline donations (Moderate): Demonstrates how to add large volumes of offline donations to GoFundMe Pro. This process saves time on individual manual uploads or engaging GoFundMe Pro's Professional Services.
- Note: We strongly recommend using the Mock Server to test this workflow first. Running these requests using your API key will permanently add transaction data to your organization and campaigns. Exercise caution when using this collection and make sure you truly mean to add offline donations before proceeding. Organizations using this collection are solely responsible for managing imported data and ensuring data accuracy.
For instructions on how to import each collection and environment variables, refer to the README file at the root of each sample app repository. Once a Postman collection has been imported into your workspace, please refer to the documentation in the collection to understand what calls to make.
Custom samples
You must have your GoFundMe Pro API key and secret ready to try these custom apps. If you don’t, here are some helpful resources:
These full-stack applications, built with Node and React, demonstrate how to create custom leaderboard and progress bar widgets for your website.
- Custom leaderboard (Advanced): This sample covers exchanging credentials for an access token, using the token to pull data from top-performing fundraising pages and teams, and displaying the data as individual card components in your UI.
- Custom progress bar (Advanced): This sample covers exchanging credentials for an access token, using the token to pull data from the GoFundMe Pro API, and displaying a campaign's progress relative to its goal and total donations received as a progress bar component in your UI.
To run the full-stack samples applications, you will need to set up a local development environment, following the README file instructions for each app.
Frequently asked questions
Who should use these example collections and sample apps?
These apps are intended for organizations or partners who would like to use the GoFundMe Pro API to create custom applications, data connectors, or other extensions outside of the GoFundMe Pro platform.
You do not need to be a professional developer or have extensive coding experience to use them, though each app varies in terms of the technical skill recommended and overall difficulty.
If you are new to API development, or do not want to install a local development environment on your computer, we recommend starting with the Postman examples. If you have never used Postman before, we strongly recommend following Postman’s Getting Started guide first.
Do I need a valid GoFundMe Pro API key to try out the samples?
GoFundMe Pro API keys are not required to try the Postman examples. If you don't have GoFundMe Pro credentials, or would prefer to not make these API calls against your GoFundMe Pro account, you can leverage a Mock Server included in our Postman collections.
Valid GoFundMe Pro API keys are required to try the custom samples.
If you are a GoFundMe Pro partner, please reach out to partners@gofundme.org to request API access.
Can I copy and paste the sample code as-is to create my own project or API app? Will I need to take additional steps to use the code in a live app?
The code included in the custom sample apps is intended as a guide for how to build integrations and applications with our API. These examples are instructional materials and not production-ready applications for your organization.
You should consider if your organization’s needs would require changes to the code before the app could be used with your real data.
What is the Mock Server? Are there differences between the Postman Mock Server responses and real GoFundMe Pro API responses?
The Mock Server included in our Postman collections is intended to simulate how the GoFundMe Pro API generally responds to the API requests included in the examples. The responses use a mixture of hard-coded data and mocked data to mimic executing requests against the API.
The Mock Server does not include all GoFundMe Pro API endpoints or all possible request bodies, so you should expect a wider range of possible responses when making calls to real GoFundMe Pro API endpoints.