Qodex.ai

Search for Volunteers

GET {{baseUrl}}/api/Volunteer/Search?volunteerOpportunityId=<integer>&volunteerId=<integer>&contactId=<integer>&contactIndividualId=<integer>&emailAddress=<string>&skip=<integer>&take=<integer>

Available starting 3/29/2022

Request Params

KeyDatatypeRequiredDescription
volunteerOpportunityIdstringThe volunteer opportunity identifier.
volunteerIdstringThe volunteer identifier.
contactIdstringThe contact identifier.
contactIndividualIdstringThe contact individual identifier.
emailAddressstringThe email address of the volunteer.
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;:0,&quot;volunteerUrl&quot;:&quot;string&quot;,&quot;createDateTimeUtc&quot;:&quot;dateTime&quot;,&quot;createdByUser&quot;:&quot;string&quot;,&quot;modifiedDateTimeUtc&quot;:&quot;dateTime&quot;,&quot;modifiedByUser&quot;:&quot;string&quot;,&quot;contactId&quot;:0,&quot;contactIndividualId&quot;:0,&quot;contactUrl&quot;:&quot;string&quot;,&quot;displayName&quot;:&quot;string&quot;,&quot;firstName&quot;:&quot;string&quot;,&quot;avatarUrl&quot;:&quot;string&quot;,&quot;primaryPhone&quot;:&quot;string&quot;,&quot;primaryEmail&quot;:&quot;string&quot;,&quot;totalHours&quot;:0,&quot;timesVolunteered&quot;:0,&quot;volunteerAttendanceUrl&quot;:&quot;string&quot;,&quot;volunteerOpportunityId&quot;:0,&quot;volunteerOpportunityUrl&quot;:&quot;string&quot;}],&quot;total&quot;:0}