Example API Calls

Here are example API calls using the REACH RESTful API. Unless otherwise noted, all calls use http basic authentication. Results from the endpoints are returned in JSON.

Note: For the below curl examples, you will need to do the following to use for your account:

  1. Replace demo.reachapp.co with your account’s REACH domain
  2. Replace “03c3b49b4e8255373” with your Admin’s API Key
  3. Replace “a97944be6f36f35b2b48adad675f19c36b516711” with your Admin’s API Secret
  4. Replace “:id” with the numerical ID or permalink of the record you are requesting

Example API Calls:

Return a collection of donations
curl https://demo.reachapp.co/api/v2/donations.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a single donation
curl https://demo.reachapp.co/api/v2/donations/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a collection of groups
curl https://demo.reachapp.co/api/v2/groups.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a single group
curl https://demo.reachapp.co/api/v2/groups/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a collection of supporters
curl https://demo.reachapp.co/api/v2/supporters.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a single supporter
curl https://demo.reachapp.co/api/v2/supporters/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a collection of sponsorships
curl https://demo.reachapp.co/api/v2/sponsorships.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a single sponsorship
curl https://demo.reachapp.co/api/v2/sponsorships/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a collection of events
curl https://demo.reachapp.co/api/v2/events.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a single event
curl https://demo.reachapp.co/api/v2/events/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a collection of campaigns
curl https://demo.reachapp.co/api/v2/campaigns.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a single campaign
curl https://demo.reachapp.co/api/v2/campaigns/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a collection of projects
curl https://demo.reachapp.co/api/v2/projects.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a single project
curl https://demo.reachapp.co/api/v2/projects/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a collection of places
curl https://demo.reachapp.co/api/v2/places.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

Return a single project
curl https://demo.reachapp.co/api/v2/places/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"

For more information, see our API Documentation article or contact our Support team.

Tags: ,

Was this article helpful?

Previous Article

API Documentation

Next Article

Zapier Integration