Example API Calls

This is documentation for v1 of the REACH API end points. 

Unless otherwise noted, all calls to the REACH API use HTTP basic authentication over HTTPS.

Below are examples using curl. Most languages have a set of tools around curl or RESTful APIs that can be used to interact with the REACH API. Results from the endpoints are returned in JSON.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Feedback and Knowledge Base