Springly's API

Springly has an API!

Great — but what does it actually do?

Simply put, an API ("application programming interface") is a software interface that lets you "connect" one application to another to exchange data and functionality.

With Springly, our API lets you interact with our system directly — no need to go through our interface — so you can:

• Retrieve all the information you need about your organizations, contacts, and members;
• Update that information to keep your own system in sync with Springly.

The practical upside: an administrator who enters information in Springly no longer has to duplicate the same update in a separate system!

Our API covers the CRM ("Community") features of our platform. Other Springly features do not (yet) have an API.

Who is this for?

This API is intended for administrators of nonprofits who need their own information systems to work alongside and communicate with Springly.

While relatively straightforward, implementing an API puts you squarely in the advanced Springly user category! We recommend that customers either have sufficient technical knowledge before diving in, or work with a professional (such as an agency).

⚠️ Please note: API access requires a subscription to our Professional plan.

How does it work?

Set up your Springly account and subscribe to the Professional plan

Start by creating a Springly account.

We do not have a sandbox environment. To test your integrations without using your production data, we recommend signing up for a separate test account.

Once that's done, you can configure your test nonprofit and explore all the features of the platform.

Request access

Our API is not publicly open — access is controlled. Only Professional plan customers can request access.

Each customer receives a unique key to authenticate and access our resources.

First, you'll need to apply to our API program. To do so, please send our Support team a detailed request describing your project.

Please include the name of your platform (or the platforms for which you are requesting API keys).

Once you're accepted into our API program, we'll provide your API keys (for your test environment and your production environment), along with the identifier for your network or main organization.

Deploy the API

After our team reviews your project, we'll share the technical documentation with you.

That said, Springly does not provide hands-on support for API integration.

If you have questions about specific points in the documentation, limited technical support is available by email (you'll receive the email address when you join the API program).

A few simple use cases

Display your contacts in a directory on your website

You can display on your website (managed outside of Springly) a directory of people you want to highlight (hosted outside of Springly).

With your CRM managed in Springly, the directory can be displayed via API and will automatically reflect any updates.

This lets you showcase your member network, a list of experts, your roster of coaches, and more.

Create contacts and add them to a group from an external form

You can connect an external contact form to Springly and update contact information directly in your Springly CRM.

This is useful for recruiting volunteers or donors, for example.