Query Volunteers

POST

/api/Volunteer/Query

POST

/api/Volunteer/Query

curl -X POST https://api.virtuoussoftware.com/api/Volunteer/Query \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Volunteering_queryVolunteers_example

{
  "list": [
    {
      "id": 1245,
      "volunteerUrl": "https://app.virtuoussoftware.com/volunteers/1245",
      "createDateTimeUtc": "2023-11-15T09:30:00Z",
      "createdByUser": "jane.doe@nonprofit.org",
      "modifiedDateTimeUtc": "2024-04-10T14:45:00Z",
      "modifiedByUser": "john.smith@nonprofit.org",
      "contactId": 56789,
      "contactIndividualId": 98765,
      "contactUrl": "https://app.virtuoussoftware.com/contacts/56789",
      "displayName": "Emily Johnson",
      "firstName": "Emily",
      "avatarUrl": "https://cdn.virtuoussoftware.com/avatars/emilyjohnson.jpg",
      "primaryPhone": "+1-555-123-4567",
      "primaryEmail": "emily.johnson@example.com",
      "totalHours": 152,
      "timesVolunteered": 18,
      "volunteerAttendanceUrl": "https://app.virtuoussoftware.com/volunteers/1245/attendance",
      "volunteerOpportunityId": 321,
      "volunteerOpportunityUrl": "https://app.virtuoussoftware.com/opportunities/321"
    }
  ],
  "total": 1
}

Available starting 3/29/2022

Authentication

AuthorizationBearer

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

Response

listlist of objectsOptional

totalintegerOptional