Search for Volunteers | Virtuous Developer Documentation

curl -G https://api.virtuoussoftware.com/api/Volunteer/Search \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     --data-urlencode volunteerOpportunityId=<integer> \
     --data-urlencode volunteerId=<integer> \
     --data-urlencode contactId=<integer> \
     --data-urlencode contactIndividualId=<integer> \
     --data-urlencode emailAddress=<string> \
     -d skip=1 \
     -d take=1

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

Available starting 3/29/2022

Authentication

AuthorizationBearer

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

Query parameters

volunteerOpportunityIdstringOptional

The volunteer opportunity identifier.

volunteerIdstringOptional

The volunteer identifier.

contactIdstringOptional

The contact identifier.

contactIndividualIdstringOptional

The contact individual identifier.

emailAddressstringOptional

The email address of the volunteer.

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10.

Response

listlist of objectsOptional

totalintegerOptional