Get Volunteer Opportunities

GET {{baseUrl}}/api/VolunteerOpportunity?filter=<string>&skip=<integer>&take=<integer>

Request Params

KeyDatatypeRequiredDescription
filterstringThe optional filter.
skipstringThe number of records to skip. Default = 0.
takestringThe number of records to take. Default = 10.

RESPONSES

status: OK

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