Peach API Documentation
This is the complete API documentation for connecting to the Peach API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Peach: Peach is a fundraising and nonprofit management platform for campaigns, contacts, payments, transactions, and notes. Keep reading to get started.
Quickstart
Before you run your first Peach request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Peach connection — create or choose one in Connections. Note its
connectionId.
Every Peach action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/peach/actions/{actionSlug}/runYou need a MindCloud API Key and a Peach connection. Then call an action such as List Transactions:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/peach/actions/list-transactions/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Peach account. See Peach API Authentication for the full flow and how to get your connection credentials.
Peach actions
All 20 published actions for this Peach version. Each page documents the endpoint, arguments, and response controls.
- PUTCancel Subscription
- PUTChange Subscription Charge Day
- POSTCreate Contact
- POSTCreate Note
- POSTCreate One-Time Payment
- POSTCreate Subscription Payment
- DELETEDelete Contact
- PUTFreeze Subscription
- GETGet Campaign
- GETGet Campaign Stats
- GETGet Contact By Email
- GETGet Contact By ID
- GETGet Contact By Phone
- GETGet Contact By Tz
- GETList Transactions
- GETList Transactions By Campaign
- PUTUpdate Contact
- PUTUpdate Payment Field
- PUTUpdate Subscription Additional Sum
- PUTUpdate Subscription Cycles
Related apps
More Sales & CRM apps on the Universal API, behind the same REST shape. Or browse all apps.