VolunteerMatch

Introduction

What is an API?

How to use our API

What is GraphQL?

Examples

Authentication

Create Connection

Get Connections

Search Opportunities

GraphQL API Specification

VolunteerMatch API Documentation

Complete reference documentation for the VolunteerMatch API. Included are code snippets and examples for GraphQL, cURL, Ruby, Python, Java, PHP, Node.js, Go, and .NET.

Production

Sandbox

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">The VolunteerMatch Open Network API V3 is built with GraphQL, which provides access to the entirety of our volunteering database. Using a flexible query language like GraphQL gives you more control, allowing you to tailor the VolunteerMatch experience to match your community&apos;s needs and expectations. </p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">You can learn more about our API options and see live examples <a href="https://solutions.volunteermatch.org/open-network-api" target="_self">here</a>.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Read on to learn more about APIs and how to use ours.</p><p class="slate-p" placeholder="Type / for widgets"></p>

The VolunteerMatch Open Network API V3 is built with GraphQL, which provides access to the entirety of our volunteering database. Using a flexible query language like GraphQL gives you more control, allowing you to tailor the VolunteerMatch experience to match your community's needs and expectations. 

You can learn more about our API options and see live examples 

Read on to learn more about APIs and how to use ours.

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">An API, which stands for &quot;Application Programming Interface,&quot; is like a messenger or translator that allows two different software programs to communicate with each other.</p><p class="slate-p" placeholder="Type / for widgets">In the world of software, an API is a set of rules and protocols that allows different applications to &quot;talk&quot; to each other. When you use an app on your phone or computer, it might be using an API to connect to a server or database to get the information it needs to function properly.</p><p class="slate-p" placeholder="Type / for widgets">For example, if you use a weather app to check the forecast, the app might use an API to connect to a weather service that provides up-to-date weather information. The app sends a request to the API for the current weather data, and the API responds with the data the app needs.</p><p class="slate-p" placeholder="Type / for widgets">In the case of VolunteerMatch, you can use our APIs to get information from or to change data in our application.  One example would be using our API to get a list of opportunities based on some specifications (location, cause area, etc) to display on your website.  Another example would be using the API to add or remove an opportunity in our database.  </p><p class="slate-p" placeholder="Type / for widgets">So, an API basically acts as an intermediary between two different software applications, allowing them to communicate and exchange information in a standardized way. This makes it easier for developers to build new applications and services that can work with other existing systems.</p>

An API, which stands for "Application Programming Interface," is like a messenger or translator that allows two different software programs to communicate with each other.

In the world of software, an API is a set of rules and protocols that allows different applications to "talk" to each other. When you use an app on your phone or computer, it might be using an API to connect to a server or database to get the information it needs to function properly.

For example, if you use a weather app to check the forecast, the app might use an API to connect to a weather service that provides up-to-date weather information. The app sends a request to the API for the current weather data, and the API responds with the data the app needs.

In the case of VolunteerMatch, you can use our APIs to get information from or to change data in our application.  One example would be using our API to get a list of opportunities based on some specifications (location, cause area, etc) to display on your website.  Another example would be using the API to add or remove an opportunity in our database.  

So, an API basically acts as an intermediary between two different software applications, allowing them to communicate and exchange information in a standardized way. This makes it easier for developers to build new applications and services that can work with other existing systems.

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Using our API typically involves the following steps:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative">Register for an API key: Our API requires you to get an API key from us, which is a unique identifier that is used to authenticate API requests.</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">You can read more about our plans and pricing <a href="https://solutions.volunteermatch.org/api/pricing?hsCtaTracking=5761d58a-be08-4610-97ac-ae66d32013c2%7Cf89d2e7e-3c7b-4456-a369-15d013f06c34" target="_blank">here</a></div></li><li class="slate-li"><div style="position:relative">Start the registration process by filling out <a href="https://solutions.volunteermatch.org/business/hello?hsCtaTracking=f3b4fa83-3f93-4f64-9b5c-db8c10f5626c%7Cf223756a-4d0b-4659-8129-c4aee19ed84e" target="_self">this form</a></div></li></ul></li><li class="slate-li"><div style="position:relative">Visit our <a href="https://github.com/volunteermatch/vm-contrib/tree/master/graphql" target="_self">Github page</a> for more API documentation and examples</div></li><li class="slate-li"><div style="position:relative">Start making API requests (<a href="https://impactonline.atlassian.net/wiki/spaces/VONA/pages/2250080261/Introduction+to+APIs#examples" target="_blank">see request examples below</a>): API requests are usually made using HTTP methods such as GET, POST, PUT, and DELETE. The request is sent to a specific endpoint, along with any required parameters and the API key.  Here are some requests you can make:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative">searchOpportunities - allows you to search our expansive database of volunteer opportunities. The data will be returned by the API in JSON format</div></li><li class="slate-li"><div style="position:relative">createConnections - allows you to create connections between users and VolunteerMatch opportunities </div></li><li class="slate-li"><div style="position:relative">getConnections - allows you to get a list of connections</div></li></ul></li><li class="slate-li"><div style="position:relative">Parse the API response: The API will return a response, which will most likely be in JSON format like <a href="https://impactonline.atlassian.net/wiki/spaces/VONA/pages/2250080261/Introduction+to+APIs#response" target="_blank">this example below</a>. The response must be parsed in order to extract the data you need.</div></li><li class="slate-li"><div style="position:relative">Use the API data: Once you have parsed the API response, you can use the data in your own software application as needed.</div></li></ol><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Here are some other helpful tools for learning about and testing GraphQL with our API:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><a href="https://media.volunteermatch.org/federation/index.html" target="_blank">VolunteerMatch GraphQL Schema Browser</a></div></li><li class="slate-li"><div style="position:relative">Along with using the API explorer you can also <a href="https://www.stage.volunteermatch.org/s/graphiql" target="_blank">test out your queries here</a> (there is also a documentation explorer you can use) </div></li><li class="slate-li"><div style="position:relative"><a href="https://www.postman.com/" target="_blank">Postman API Platform | Sign Up for Free</a> (can also generate code like the examples below)</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

Using our API typically involves the following steps:

Here are some other helpful tools for learning about and testing GraphQL with our API:

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">GraphQL is a Query Language that helps Application Programming Interfaces (APIs) fetch only that data which is requested by the client, and nothing else. This enormously reduces the redundant data at the API endpoint and making the requests blazing fast and developer friendly.  Because GraphQL operates over HTTP, you can use any language, client library, or tool to fetch GraphQL data so long as you format the HTTP request properly.</p><p class="slate-p" placeholder="Type / for widgets">GraphQL has a number of benefits over traditional REST APIs, including:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">More efficient and flexible: With GraphQL, you can request exactly the data you need, and nothing more. This means that you don&apos;t waste bandwidth and resources retrieving data that you don&apos;t need.</div></li><li class="slate-li"><div style="position:relative">Strongly typed: GraphQL has a schema that describes the types of data that are available, making it easier to catch errors and ensuring that clients receive the right data.</div></li><li class="slate-li"><div style="position:relative">Works well with modern front-end frameworks: GraphQL is designed to work well with modern front-end frameworks like React, Angular, and Vue, making it easier to build fast, responsive, and scalable applications.</div></li></ul><p class="slate-p" placeholder="Type / for widgets">Overall, GraphQL is a more efficient and flexible way to request data from APIs, and has become a popular choice for building modern, scalable applications.</p><p class="slate-p" placeholder="Type / for widgets"></p>

GraphQL is a Query Language that helps Application Programming Interfaces (APIs) fetch only that data which is requested by the client, and nothing else. This enormously reduces the redundant data at the API endpoint and making the requests blazing fast and developer friendly.  Because GraphQL operates over HTTP, you can use any language, client library, or tool to fetch GraphQL data so long as you format the HTTP request properly.

GraphQL has a number of benefits over traditional REST APIs, including:

Overall, GraphQL is a more efficient and flexible way to request data from APIs, and has become a popular choice for building modern, scalable applications.

<p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77);font-size:16px" class="slate-backgroundColor"></span></span></p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Below are a few different ways of calling our API to get some data.  </p><h3 class="slate-h3">Curl (searchOpportunities)</h3><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-22-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl --location --request POST &apos;https://graphql.stage.volunteermatch.org/graphql/&apos; --header &apos;x-api-key: API-KEY-HERE&apos; --header &apos;Content-Type: application/json&apos; --data-raw &apos;{&quot;query&quot;:&quot;query {\n  searchOpportunities(input:{\n\t\tlocation:&quot;75234&quot;\n  }){\n    currentPage\n    resultsSize\n    opportunities {\n      id\n      title\n      location{city, postalCode, region}\n      datePosted\n    }\n  }\n}&quot;,&quot;variables&quot;:{}}&apos;</div></code></pre><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77);font-size:16px" class="slate-backgroundColor">Response:</span></span></p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-23-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
  &quot;data&quot; : {
    &quot;searchOpportunities&quot; : {
      &quot;currentPage&quot; : 1,
      &quot;resultsSize&quot; : 5,
      &quot;opportunities&quot; : [ {
        &quot;id&quot; : 947176,
        &quot;title&quot; : &quot;Become a Mentor: Mercy Street&quot;,
        &quot;location&quot; : {
          &quot;city&quot; : &quot;Dallas&quot;,
          &quot;postalCode&quot; : &quot;75212&quot;,
          &quot;region&quot; : &quot;TX&quot;
        },
        &quot;datePosted&quot; : &quot;2022-01-12&quot;
      }, {
        &quot;id&quot; : 942711,
        &quot;title&quot; : &quot;test gov&apos;t dallas&quot;,
        &quot;location&quot; : {
          &quot;city&quot; : &quot;Dallas&quot;,
          &quot;postalCode&quot; : &quot;75229&quot;,
          &quot;region&quot; : &quot;TX&quot;
        },
        &quot;datePosted&quot; : &quot;2022-01-12&quot;
      }, {
        &quot;id&quot; : 947063,
        &quot;title&quot; : &quot;Become a Mentor: Big Brothers Big Sisters Lone Star&quot;,
        &quot;location&quot; : {
          &quot;city&quot; : &quot;Irving&quot;,
          &quot;postalCode&quot; : &quot;75062&quot;,
          &quot;region&quot; : &quot;TX&quot;
        },
        &quot;datePosted&quot; : &quot;2022-01-12&quot;
      }, {
        &quot;id&quot; : 947079,
        &quot;title&quot; : &quot;Become a Mentor: All Things Made New&quot;,
        &quot;location&quot; : {
          &quot;city&quot; : &quot;Irving&quot;,
          &quot;postalCode&quot; : &quot;75060&quot;,
          &quot;region&quot; : &quot;TX&quot;
        },
        &quot;datePosted&quot; : &quot;2022-01-12&quot;
      }, {
        &quot;id&quot; : 942816,
        &quot;title&quot; : &quot;map loc testing&quot;,
        &quot;location&quot; : {
          &quot;city&quot; : &quot;around texas&quot;,
          &quot;postalCode&quot; : &quot;75261&quot;,
          &quot;region&quot; : &quot;TX&quot;
        },
        &quot;datePosted&quot; : &quot;2022-01-12&quot;
      } ]
    }
  }
}</div></code></pre><h3 class="slate-h3">Fetch (searchOpportunities)</h3><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">You can make a GraphQL HTTP request in literally any programming language. So let’s convert that curl request into some JavaScript code with fetch, the new standard for getting HTTP results with promises. This will work in modern browsers with no libraries, but will require a polyfill in Node and <a href="http://caniuse.com/#search=Fetch" target="_blank">some browsers</a>. Here is an example (response will look similar to the curl response above):</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-24-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">var myHeaders = new Headers();
myHeaders.append(&quot;x-api-key&quot;, &quot;API-KEY-HERE&quot;);
myHeaders.append(&quot;Content-Type&quot;, &quot;application/json&quot;);</div><div class="slate-code_line">var graphql = JSON.stringify({
query: query {
  searchOpportunities(input:{
    location: &quot;san francisco&quot;
    categories:[childrenAndYouth, community]
    pageNumber:1
    sortCriteria: update
  }){
    resultsSize,
    opportunities{
      id,
      title 
      categories
      specialFlag
  }}
  }
})
var requestOptions = {
method: &apos;POST&apos;,
headers: myHeaders,
body: graphql,
redirect: &apos;follow&apos;
};</div><div class="slate-code_line">fetch(&quot;https://graphql.stage.volunteermatch.org/graphql/&quot;, requestOptions)
.then(response =&gt; response.text())
.then(result =&gt; console.log(result))
.catch(error =&gt; console.log(&apos;error&apos;, error));</div></code></pre><h3 class="slate-h3">NodeJs with axios (getConnections)</h3><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-25-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">var axios = require(&apos;axios&apos;);
var data = JSON.stringify({
query: query{getConnections(
  input:{
      orgId:342308
    dateRange:&quot;2022-05-27 to 2023-02-08&quot;})
  {
    numberOfResults
    connections{
      connectionDate
      opportunity {
        id
        parentOrg {
          id
        }
        title
        expiration
      }
    }
  }
},
variables: {}
});</div><div class="slate-code_line">var config = {
method: &apos;post&apos;,
url: &apos;https://graphql.stage.volunteermatch.org/graphql/&apos;,
headers: {
&apos;x-api-key&apos;: &apos;API-KEY-HERE&apos;,
&apos;Content-Type&apos;: &apos;application/json&apos;,
},
data : data
};</div><div class="slate-code_line">axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});</div></code></pre><p class="slate-p" placeholder="Type / for widgets">Response:</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-26-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
  &quot;data&quot;: {
    &quot;getConnections&quot;: {
      &quot;numberOfResults&quot;: 2,
      &quot;connections&quot;: [
        {
          &quot;connectionDate&quot;: &quot;2022-06-13&quot;,
          &quot;opportunity&quot;: {
            &quot;id&quot;: 947022,
            &quot;parentOrg&quot;: {
              &quot;id&quot;: 342308
            },
            &quot;title&quot;: &quot;Become a Mentor: VIP Mentoring Program - Community Based&quot;,
            &quot;expiration&quot;: &quot;2025-12-31&quot;
          }
        },
        {
          &quot;connectionDate&quot;: &quot;2022-05-31&quot;,
          &quot;opportunity&quot;: {
            &quot;id&quot;: 947022,
            &quot;parentOrg&quot;: {
              &quot;id&quot;: 342308
            },
            &quot;title&quot;: &quot;Become a Mentor: VIP Mentoring Program - Community Based&quot;,
            &quot;expiration&quot;: &quot;2025-12-31&quot;
          }
        }
      ]
    }
  }
}</div></code></pre><p class="slate-p" placeholder="Type / for widgets"></p>

Below are a few different ways of calling our API to get some data.  

You can make a GraphQL HTTP request in literally any programming language. So let’s convert that curl request into some JavaScript code with fetch, the new standard for getting HTTP results with promises. This will work in modern browsers with no libraries, but will require a polyfill in Node and 

. Here is an example (response will look similar to the curl response above):

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Welcome to the Open Network API V3, built with GraphQL. This API grants access to the <a href="https://www.volunteermatch.org/" target="_blank">VolunteerMatch Open Network</a>.</p><p class="slate-p" placeholder="Type / for widgets">Our Open Network API uses API keys to authenticate requests. You can request an API Key by filling out <a href="https://solutions.volunteermatch.org/business/hello?hsCtaTracking=f3b4fa83-3f93-4f64-9b5c-db8c10f5626c%7Cf223756a-4d0b-4659-8129-c4aee19ed84e" target="_blank">this form.</a></p><p class="slate-p" placeholder="Type / for widgets"></p>

Welcome to the Open Network API V3, built with GraphQL. This API grants access to the 

Our Open Network API uses API keys to authenticate requests. You can request an API Key by filling out 

200 - OK

The request was unacceptable, often due to missing a required parameter.

400 - Bad request

401 - Unauthorized

The parameters were valid but the request failed.

402 - Request Failed

The API key doesnt have permissions to perform the request.

403 - Forbidden

404 - Not Found

<p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Connect a Volunteer to an Opportunity</h2><p class="slate-p" placeholder="Type / for widgets">This mutation is for Volunteer Recruitment.  It provides the ability to connect a volunteer with an opportunity and if the volunteer does not exist a new account will be created.</p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><h3 class="slate-h3">Try it out!</h3><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">You can try out this query for yourself by clicking “<strong class="slate-bold">Try In API Explorer</strong>” in the query box.  Just make sure to change the email address for the volunteer or you may get an error saying <em class="slate-italic">&quot;You&apos;ve already signed up for this opportunity&quot;</em></p></div></div><p class="slate-p" placeholder="Type / for widgets">In order for a volunteer to <em class="slate-italic">express interest</em> or <em class="slate-italic">sign up</em> for an opportunity in the VolunteerMatch network, the volunteer must be a member of the VM system. Setting up the member record and making the subsequent connection can be made with a single API call: <strong class="slate-bold">createConnection</strong>. </p><p class="slate-p" placeholder="Type / for widgets">Once a volunteer finds an opportunity and is signed in, he or she <em class="slate-italic">expresses interest</em> or <em class="slate-italic">signs up</em> by clicking a button and the VolunteerMatch API facilitates the connection to the nonprofit when the <strong class="slate-bold">createConnection</strong> mutation is called. Note that, if an opportunity has shifts, a volunteer should be able to <em class="slate-italic">express interest</em> or <em class="slate-italic">sign up</em> in multiple shift IDs with one connection request.</p><p class="slate-p" placeholder="Type / for widgets"><a href="https://impactonline.atlassian.net/wiki/spaces/VONA/pages/1573781549/Best+Practices+for+the+VolunteerMatch+Open+Network+Opportunities+API#GraphQL-Mutation:-createConnection" target="_blank">More information about UI Requirements and sample UI displays</a></p><div  data-type="warning" style="background-color:#FFF8E1;color:#f0b800"><div ><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">Learn more about what fields are <strong class="slate-bold">required</strong> and all available input and response parameters by expanding the child attributes under <u class="slate-underline"><strong class="slate-bold">BODY PARAMETERS</strong></u> and <u class="slate-underline"><strong class="slate-bold">RESPONSES</strong></u><strong class="slate-bold"> </strong>below. </p><p class="slate-p" placeholder="Type / for widgets"><em class="slate-italic">Click “Expand all” to see all fields at once.</em></p></div></div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><a href="https://media.volunteermatch.org/federation/connectiondetailinput.doc.html" target="_blank">Dive deeper into Input Parameters in the GraphQL Schema</a></div></li><li class="slate-li"><div style="position:relative"><a href="https://media.volunteermatch.org/federation/connectiondetail.doc.html" target="_blank">Dive deeper into the Responses in the GraphQL Schema</a></div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This mutation is for Volunteer Recruitment.  It provides the ability to connect a volunteer with an opportunity and if the volunteer does not exist a new account will be created.

 for an opportunity in the VolunteerMatch network, the volunteer must be a member of the VM system. Setting up the member record and making the subsequent connection can be made with a single API call: 

Once a volunteer finds an opportunity and is signed in, he or she 

 by clicking a button and the VolunteerMatch API facilitates the connection to the nonprofit when the 

 mutation is called. Note that, if an opportunity has shifts, a volunteer should be able to 

 in multiple shift IDs with one connection request.

input

x-api-key

createConnection

<p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Get reporting on connections your application has made between volunteers and opportunities</h2><p class="slate-p" placeholder="Type / for widgets">Once your application has successfully connected volunteers to opportunities via the createConnection call, you may use VolunteerMatch’s <strong class="slate-bold">getConnections</strong> call to retrieve reporting of the connections you’ve generated.  </p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><h3 class="slate-h3">Try it out!</h3><p class="slate-p" placeholder="Type / for widgets">You can try out this query for yourself by clicking “<strong class="slate-bold">Try In API Explorer</strong>” in the query box. </p></div></div><h3 class="slate-h3">The getConnections call returns following information for each connection you’ve made:</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Connection information: </strong><em class="slate-italic">Connection date, volunteer’s comments, answers to custom questions, shifts selected, the source</em> that generated the connection.  See full schema of Connection detail <a href="https://media.volunteermatch.org/federation/connection.doc.html" target="_blank">here</a>.  By default, VolunteerMatch only provides connection generated by your app.  If you need data on connections generated from another source (i.e. VolunteerMatch hosted public site), your API key will need to have special configuration applied.  </div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Volunteer’s information:</strong> <em class="slate-italic">email address, first and last name, zip code, skills etc</em>. See full schema of Volunteer/Person detail <a href="https://media.volunteermatch.org/federation/persondetail.doc.html" target="_blank">here</a>.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Opportunity details: </strong><em class="slate-italic">Title, location, description, cause area etc.</em>  See full schema of Opportunity Detail  <a href="https://media.volunteermatch.org/federation/opportunitydetail.doc.html" target="_blank">here</a>.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Organization details: </strong><em class="slate-italic">Organization name, classification, ein, classification, cause area etc. </em>See full schema of Organization Detail <a href="https://media.volunteermatch.org/federation/organizationdetail.doc.html" target="_blank">here</a>.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"><a href="https://impactonline.atlassian.net/wiki/spaces/VONA/pages/1573781549/Best+Practices+for+the+VolunteerMatch+Open+Network+Opportunities+API#GraphQL-Mutation:-getConnections" target="_blank">More information about UI Requirements and sample UI displays</a></p><div  data-type="warning" style="background-color:#FFF8E1;color:#f0b800"><div ><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">Learn more about what fields are <strong style="font-size:14px" class="slate-bold">required</strong> and all available input and response parameters by expanding the child attributes under <u style="font-size:14px" class="slate-underline"><strong style="font-size:14px" class="slate-bold">BODY PARAMETERS</strong></u> and <u style="font-size:14px" class="slate-underline"><strong style="font-size:14px" class="slate-bold">RESPONSES</strong></u><strong style="font-size:14px" class="slate-bold"> </strong>below.</p><p class="slate-p" placeholder="Type / for widgets"><em style="font-size:14px" class="slate-italic">Click “expand all” to see all fields at once.</em></p></div></div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><a href="https://media.volunteermatch.org/federation/getconnectionsparamsinput.doc.html" target="_blank">Dive deeper into Input Parameters in the GraphQL Schema</a></div></li><li class="slate-li"><div style="position:relative"><a href="https://media.volunteermatch.org/federation/getconnectionsresult.doc.html" target="_blank">Dive deeper into the Responses in the GraphQL Schema</a></div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get reporting on connections your application has made between volunteers and opportunities

Once your application has successfully connected volunteers to opportunities via the createConnection call, you may use VolunteerMatch’s 

 call to retrieve reporting of the connections you’ve generated.  

The getConnections call returns following information for each connection you’ve made:

Get volunteer connections for an opportunity.

getConnections

<p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Search &amp; Display of Volunteer Opportunities</h2><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-color"><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-backgroundColor">You can try out this query for yourself by clicking “</span></span><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-color"><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-backgroundColor"><strong style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-bold">Try In API Explorer</strong></span></span><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-color"><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-backgroundColor">” in the query box. You can search using many parameter options which you can learn more about under </span></span><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-color"><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-backgroundColor"><u style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-underline"><strong style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-bold">BODY PARAMETERS</strong></u></span></span><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-color"><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64);font-size:14px" class="slate-backgroundColor"> below.</span></span></p></div></div><p class="slate-p" placeholder="Type / for widgets">The easiest implementation option, for allowing users to search for volunteer opportunities, is to display a search form, accept some parameters – location, keywords, etc. – and then make a <strong class="slate-bold">searchOpportunities</strong> call to the VolunteerMatch service. This offloads storage and search functionality to the VM service, relieving your system from needing to implement and optimize it. It allows for a number of pagination sizes and sort orders, and it will ensure that the most popular VolunteerMatch nation-wide opportunities are presented seamlessly to your users.</p><div  data-type="warning" style="background-color:#FFF8E1;color:#f0b800"><div ><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">Learn more about what fields are <strong style="font-size:14px" class="slate-bold">required</strong> and all available input and response parameters by expanding the child attributes under <u style="font-size:14px" class="slate-underline"><strong style="font-size:14px" class="slate-bold">BODY PARAMETERS</strong></u> and <u style="font-size:14px" class="slate-underline"><strong style="font-size:14px" class="slate-bold">RESPONSES</strong></u><strong style="font-size:14px" class="slate-bold"> </strong>below.</p><p class="slate-p" placeholder="Type / for widgets"><em style="font-size:14px" class="slate-italic">Click “expand all” to see all fields at once.</em></p></div></div><p class="slate-p" placeholder="Type / for widgets"><a href="https://media.volunteermatch.org/federation/opportunitysearchparamsinput.doc.html" target="_blank">Dive deeper into Input Parameters in the GraphQL Schema</a></p><p class="slate-p" placeholder="Type / for widgets"><a href="https://media.volunteermatch.org/federation/opportunitysearchresults.doc.html" target="_blank">Dive deeper into the Responses in the GraphQL Schema</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Search & Display of Volunteer Opportunities

The easiest implementation option, for allowing users to search for volunteer opportunities, is to display a search form, accept some parameters – location, keywords, etc. – and then make a 

 call to the VolunteerMatch service. This offloads storage and search functionality to the VM service, relieving your system from needing to implement and optimize it. It allows for a number of pagination sizes and sort orders, and it will ensure that the most popular VolunteerMatch nation-wide opportunities are presented seamlessly to your users.

Search and filter volunteer opportunities for volunteers to view and connect with.

Sections