Virtuous Volunteer includes an open API that allows your organization to connect your volunteer platform with external systems and processes. An Application Programming Interface (API) is a set of defined rules that allows different software applications to communicate with each other. The Volunteer API gives partner integrations programmatic access to a customer’s volunteer management data— their Users, Projects, Groups, Campaigns, Organizations, Forms, and Certificates. Using the API can save time, reduce errors, and support innovation.
Overview
Before working with the Volunteer API, it's recommended to review the API documentation in detail. This article is a high level summary of the material available in the linked API documentation.
You can access the full API documentation via this link. Here, you can find guidance for use of recommended Endpoints, common workflows, integration recipes, and more. Use the search bar for key works or ask the AI assistant for help.
Authentication
The Volunteer API authenticates with a single mechanism: a Bearer token in the HTTP Authorization header. The pattern is straightforward and follows IETF RFC 6750, but there are a few important specifics about how Volunteer’s tokens are issued and managed for integrations. Click here to learn more about Authentication.
Data Model
Before getting started with the API, it may be helpful to review the Volunteer Data Model. The Volunteer API’s data model is built around volunteer engagement: Users who participate in Projects on specific Dates, organized into Groups, attached to Opportunities (Campaigns), owned by Organizations. Understanding this model first prevents a lot of confusion downstream. Review the Volunteer Data Model here.