Queries Volunteer Opportunities

POST

/api/VolunteerOpportunity/Query

POST

/api/VolunteerOpportunity/Query

curl -X POST https://api.virtuoussoftware.com/api/VolunteerOpportunity/Query \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "groups": [
    {
      "conditions": [
        {
          "parameter": "string",
          "operator": "string",
          "value": "string",
          "secondaryValue": "string",
          "values": [
            "string"
          ]
        }
      ]
    }
  ],
  "sortBy": "string",
  "descending": false
}'

200Volunteering_queriesVolunteerOpportunities_example

{
  "list": [
    {
      "id": 1,
      "name": "Sunday Soup Kitchen",
      "url": "https://soupkitchen.org/sunday",
      "description": "Come on out to our soup kitchen and pitch in!",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "anytime": false,
      "startDateTime": "3/27/2022 12:00 PM",
      "endDateTime": "3/27/2022 6:00 PM",
      "timeZone": "US/Arizona",
      "isActive": true,
      "isLocalOnly": true,
      "currentPriority": "Medium",
      "currentNeed": 20,
      "preferredNumberOfHours": 20,
      "anywhere": false,
      "locationName": "Downtown Soup Kitchen",
      "address1": "123 Nowhere Ave",
      "address2": "Suite 200",
      "city": "Phoenix",
      "state": "AZ",
      "postal": "85004",
      "country": "US",
      "totalVolunteers": 0,
      "totalVolunteerHours": 0,
      "currentNeedFilledPercentage": 0,
      "hoursFilledPercentage": 0,
      "volunteerOrganizers": [
        {
          "id": 1,
          "contactId": 122,
          "contactIndividualId": 134,
          "displayName": "Bob Loblaw",
          "firstName": "Bob",
          "avatarUrl": null,
          "primaryPhone": "555-555-5555",
          "primaryEmail": "bob@loblaw.org",
          "contactUrl": "https://api.virtuoussoftware.com/api/Contact/122",
          "volunteerOrganizerUrl": "https://api.virtuoussoftware.com/api/VolunteerOpportunity/1/Organizers/1",
          "volunteerOpportunityUrl": "https://api.virtuoussoftware.com/api/VolunteerOpportunity/1"
        }
      ],
      "volunteerOpportunityUrl": "https://api.virtuoussoftware.com/api/VolunteerOpportunity/1",
      "volunteerOrganizersUrl": "https://api.virtuoussoftware.com/api/VolunteerOpportunity/1/Organizers/1",
      "volunteersUrl": "https://api.virtuoussoftware.com/api/VolunteerOpportunity/1/Volunteers",
      "customFields": [
        {
          "name": "Meal Options",
          "value": "Soup and Salad for Lunch, Pizza for Dinner",
          "displayName": "What meal options will be available?"
        }
      ]
    }
  ],
  "total": 1
}

Available starting 3/29/2022

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

groupslist of objectsOptional

sortBystringOptional

descendingbooleanOptional

Response

listlist of objectsOptional

totalintegerOptional