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:
- Replace demo.reachapp.co with your account’s REACH domain
- Replace “03c3b49b4e8255373” with your Admin’s API Key
- Replace “a97944be6f36f35b2b48adad675f19c36b516711” with your Admin’s API Secret
- Replace “:id” with the numerical ID or permalink of the record you are requesting
Example API Calls:
Return a collection of donationscurl https://demo.reachapp.co/api/v2/donations.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a single donationcurl https://demo.reachapp.co/api/v2/donations/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a collection of groupscurl https://demo.reachapp.co/api/v2/groups.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a single groupcurl https://demo.reachapp.co/api/v2/groups/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a collection of supporterscurl https://demo.reachapp.co/api/v2/supporters.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a single supportercurl https://demo.reachapp.co/api/v2/supporters/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a collection of sponsorshipscurl https://demo.reachapp.co/api/v2/sponsorships.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a single sponsorshipcurl https://demo.reachapp.co/api/v2/sponsorships/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a collection of eventscurl https://demo.reachapp.co/api/v2/events.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a single eventcurl https://demo.reachapp.co/api/v2/events/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a collection of campaignscurl https://demo.reachapp.co/api/v2/campaigns.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a single campaigncurl https://demo.reachapp.co/api/v2/campaigns/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a collection of projectscurl https://demo.reachapp.co/api/v2/projects.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a single projectcurl https://demo.reachapp.co/api/v2/projects/:id.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a collection of placescurl https://demo.reachapp.co/api/v2/places.json -k -u "03c3b49b4e8255373:a97944be6f36f35b2b48adad675f19c36b516711"
Return a single projectcurl 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.
Let’s Get Social