Get Volunteer Opportunities
GET {{baseUrl}}/api/VolunteerOpportunity?filter=<string>&skip=<integer>&take=<integer>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter | string | The optional filter. | |
skip | string | The number of records to skip. Default = 0. | |
take | string | The number of records to take. Default = 10. |
RESPONSES
status: OK
{"list":[{"id":1,"name":"Sunday Soup Kitchen","url":"https://soupkitchen.org/sunday","description":"Come on out to our soup kitchen and pitch in!","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","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}