Skip to main content

Virtuous Volunteer Client API FAQs

Molly Kinder
  • Updated
Note: In a recent product update,
Projects were renamed to Opportunities
Campaigns were renamed to Initiatives.

However, the code for the Virtuous Volunteer API/Webhooks
will continue to use the terms
Projects and Campaigns.

The Virtuous Volunteer Client API is a REST-based and allows you to query and pull certain aspects of your data within Virtuous Volunteer. API access can be enabled for any Virtuous Volunteer client. Please talk with your Virtuous Volunteer Partner Success Representative to enable the API and be able to generate API Keys.

How do I get access to the Virtuous Volunteer Client API?

The Virtuous Volunteer Client API is available as an add-on to all subscription packages. To request API Access for your org and add this functionality to your package, contact your Customer Success Manager. You will find a link to this in the list of integrations on the Admin Dashboard Integrations Menu.

vomo1.png

Once you have API Access Enabled, you will have API Settings in the Admin Dashboard Side Menu. This Dashboard will allow you to Generate your API Key, as well as Revoke generated API Keys.

API Key.png

Note: Administrators will receive email reminders to rotate their keys every 90 days. Every two years, your API key will automatically rotate; from there, you will have a 7-day grace period to update your systems with the new key. Be sure to update your systems within that timeframe to avoid any interruptions. 

Where do I find the Client API Website?

The link below is a website with built in documentation about the Virtuous Volunteer Client API. You can even run some test GETs to see what data is exposed through our API.

https://api.vomo.org/api/docs

What Get, Post, Put, and Delete Requests Exist?

The Virtuous Volunteer Client API exposes six major kinds of data categories through . They are:

  1. Campaigns
    • List Campaigns
    • Get Campaign Details
  2. Forms
    • List Forms
    • Get Form Completions (submissions) as a whole
    • Individual Form Completion (submission)
  3. Groups
    • List Groups
    • Create a New Group
    • Update a Group
    • Delete a Group
    • Get Members of Group
    • Update Members in a Group.
  4. Organizations
    • List Organizations (child accounts) in your family
    • Get Org Details
  5.  Projects
    • List Projects
    • Create Projects
    • Get Project Details
    • Update a Project
    • Get Project Date Details (Serving Dates)
  6.  Users
    • List Users
    • Post (Create/Update) Users
    • Get User Details (Participation Data)

How does authentication work?

Authentication to the Virtuous Volunteer API is handled via a Bearer token in the Authorization header. Tokens can be created in the admin portal once API access is enabled for your account. The authorization header should look like the following once complete.

Authorization: Bearer eyJhbGci.....yu5CSpyHI

IETF Standard: https://tools.ietf.org/html/rfc6750

 

Related articles