Skip to main content

Understanding the GiveCampus API

Updated

The GiveCampus Gift API and the third-party connectors that use it provide a simple and modern approach to integrating with your CRM and the tools that help you innovate.

What is the GiveCampus API?

The GiveCampus API is a fast, secure means of transferring data from the GiveCampus platform to another location, often donor database or CRM (Customer Relationship Management software). It is currently limited to gift, donor, event and registration information and was designed originally to support gift entry and reconciliation.

How is it used?

The GiveCampus API is most often used in one of two ways

Partner schools develop custom scripts to query the API and do the following:

  • Obtain gift and other data to support gift entry
  • Generate a list of events for a campus calendar or website
  • Obtain event registration data for event preparation and entry into a CRM
  • Generate a list of designations or designation groups in use to audit where and how they are visible to donors
  • Make automated updates to the school list of designations or designation groups
  • Import constituents and the wholistic "imported gifts" history necessary to power certain data-powered features

Third-party vendors have built API-enabled connectors and work with schools to transmit gift and constituent data from GiveCampus directly into their CRM. To date, the following solutions support the Gifts API.

What can I access with the GiveCampus API?

  • Gifts, including the relevant constituent and recurring data, from Online Giving (GC Social Fundraising & GC Giving Forms)
    • Retrieve a list of transactions and their data by timestamp, date range, and gift status
    • Additional documentation below
  • Events and Registrations from GC Events
    • Retrieve a list of events and their data by date range and status
    • Retrieve a list of event registrations and their data by event id, date range, and registration status
    • Additional documentation below
  • Designations from Online Giving
    • Retrieve a list of all designation in use and their data, including any designation group, campaign or giving form they are connected to
    • Create new designations (individually or in bulk) using a list from your school
      • Will deduplicate if all attributes match an existing designation
    • Additional documentation below
  • Designation Groups from Online Giving
    • Retrieve a list of all designation groups and their designations
    • Bulk create designation groups for your school
    • Additional documentation below
  • Recurring Subscriptions from Online Giving 
    • Retrieve a list of all recurring subscriptions and their data including installment data
    • Retrieve the data from a specific recurring subscription using its subscription ID
    • Additional documentation below 
  • Form Fields from Online Giving
    • Retrieve all standard and custom form fields in use by the school, along with information about the form or campaign where they are in use
    • Additional documentation below
  • Constituents used in Online Giving, GC Wealth and GC Events 
    • Retrieve a list of all constituents for your school in GiveCampus
    • Bulk create and modify constituents in GiveCampus
    • Additional documentation below
  • Imported Gifts from Online Giving, GC Wealth and GC Events
    • Retrieve a list of all imported gifts (including those imported via the School Dashboard Data Importer)
    • Bulk create and modify historical gift histories imported from your CRM that donor status calculations and other data-powered tools
    • Additional documentation below
  • The following are not yet accessible as their own calls, but are being explored by our team:
    • Interactions (for GC Gift Officer)
    • Contact Reports (for GC Gift Officer)

Can I send data to GiveCampus using the API?

Most API uses are based on a GET (retrieval) request, which does not allow writing or posting to GiveCampus data. For the some data types (designations, constituents, imported gifts), you can POST (write new) or PUT (modify existing) data. Check the relevant API call type documentation below to see what types of requests are possible.

How do I access it?

To generate API tokens used to access the API, go to Online Giving > Reporting > Settings > API Tokens.

 

What documentation can I give my technical team?

You can direct them to our API Documentation site, which includes:

  • Request, result, and data models including field name, type, and description
  • A testing tool (using your an API token from your school) to understand the request lifecycle and parameters
  • Additional security information

Users must log in to access the information (they do not need to be GiveCampus school admins)

  • Username: givecampus
  • Password: apiuser

Available documentation pages:

Where can I learn more about the parameters used by the API?

Who can I ask if I have more questions?

Reach out to us at support@givecampus.com!

Related articles