GET api/v2.0/Volunteer/GetUpcomingVolunteerOpportunities?opportunityTypeKey={opportunityTypeKey}&communityKey={communityKey}&maxToRetrieve={maxToRetrieve}

Returns Upcoming VolunteerOpportunies for Current User.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
opportunityTypeKey

Optional parameter. When included, limits returned Posts to this Opportunity Type.

globally unique identifier

None.

communityKey

Optional parameter. When included, limits returned Posts to this Community if Associated with the Opportunity.

globally unique identifier

None.

maxToRetrieve

Maximum records to retrieve.

integer

Default value is 20

Body Parameters

None.

Response Information

Resource Description

Collection of VolunteerOpportunity
NameDescriptionTypeAdditional information
VolunteerOpportunityKey

The Unique Identifier for the Volunteer Opportunity.

globally unique identifier

None.

Title

The Title of the Volunteer Opportunity.

string

None.

Description

Descriptions for the Volunteer Opportunity.

string

None.

Deadline

Sign-up deadline for the Volunteer Opportunity.

string

None.

AdditionalRequirements

Additional Volunteer Requirements for this Volunteer Opportunity.

string

None.

Location

Location for the Volunteer Opportunity.

string

None.

VolunteersNeeded

Number of Volunteers needed for this Volunteer Opportunity.

integer

None.

CreatedOn

Date the Volunteer Opportunity was created.

date

None.

CloseDate

Date that registration as a Volunteer Closes.

date

None.

UpdatedOn

Date this Volunteer Opportunity was last updated.

date

None.

EstimatedHours

Estimated Hours required for the Volunteer Opportunity.

decimal number

None.

SkillMultiplier

decimal number

None.

StartDateTime

Date and Time the Volunteer Opportunity begins.

date

None.

EndDateTime

Date and Time the Volunteer Opportunity ends.

date

None.

Community

If the Volunteer Opportunity is linked to a specific Community, this will contain the Community data for that Community.

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "VolunteerOpportunityKey": "d2fd607a-6dfe-4579-8abe-d4a6039d30ef",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "Deadline": "sample string 4",
    "AdditionalRequirements": "sample string 5",
    "Location": "sample string 6",
    "VolunteersNeeded": 7,
    "CreatedOn": "2022-08-12T20:43:01.9160173Z",
    "CloseDate": "2022-08-12T20:43:01.9160173Z",
    "UpdatedOn": "2022-08-12T20:43:01.9160173Z",
    "EstimatedHours": 11.0,
    "SkillMultiplier": 12.0,
    "StartDateTime": "2022-08-12T20:43:01.9160173Z",
    "EndDateTime": "2022-08-12T20:43:01.9160173Z",
    "Community": null,
    "RequiresApproval": true,
    "Status": 0,
    "StatusText": "sample string 16",
    "CanSignUpViaApi": true,
    "ApplicationStatus": 0,
    "ApplicationStatusText": "sample string 18",
    "VolunteerOpportunityTypeKey": "f60fb060-662d-4e7c-8d38-765e442aa545",
    "LinkToListOfOpportunities": "sample string 20",
    "PictureUrl": "sample string 21",
    "LinkToOpportunity": "sample string 22",
    "OpportunityName": "sample string 23",
    "OpportunityAddress": "sample string 24",
    "VolunteerSpotsAvailable": 25,
    "Points": 26,
    "VolunteerOpportunityIntegrationCode": "sample string 27"
  },
  {
    "VolunteerOpportunityKey": "d2fd607a-6dfe-4579-8abe-d4a6039d30ef",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "Deadline": "sample string 4",
    "AdditionalRequirements": "sample string 5",
    "Location": "sample string 6",
    "VolunteersNeeded": 7,
    "CreatedOn": "2022-08-12T20:43:01.9160173Z",
    "CloseDate": "2022-08-12T20:43:01.9160173Z",
    "UpdatedOn": "2022-08-12T20:43:01.9160173Z",
    "EstimatedHours": 11.0,
    "SkillMultiplier": 12.0,
    "StartDateTime": "2022-08-12T20:43:01.9160173Z",
    "EndDateTime": "2022-08-12T20:43:01.9160173Z",
    "Community": null,
    "RequiresApproval": true,
    "Status": 0,
    "StatusText": "sample string 16",
    "CanSignUpViaApi": true,
    "ApplicationStatus": 0,
    "ApplicationStatusText": "sample string 18",
    "VolunteerOpportunityTypeKey": "f60fb060-662d-4e7c-8d38-765e442aa545",
    "LinkToListOfOpportunities": "sample string 20",
    "PictureUrl": "sample string 21",
    "LinkToOpportunity": "sample string 22",
    "OpportunityName": "sample string 23",
    "OpportunityAddress": "sample string 24",
    "VolunteerSpotsAvailable": 25,
    "Points": 26,
    "VolunteerOpportunityIntegrationCode": "sample string 27"
  }
]

application/xml, text/xml

Sample:
<ArrayOfVolunteerOpportunity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Volunteer">
  <VolunteerOpportunity>
    <AdditionalRequirements>sample string 5</AdditionalRequirements>
    <ApplicationStatusText>sample string 18</ApplicationStatusText>
    <CloseDate>2022-08-12T16:43:01.9160173-04:00</CloseDate>
    <CreatedOn>2022-08-12T16:43:01.9160173-04:00</CreatedOn>
    <Deadline>sample string 4</Deadline>
    <Description>sample string 3</Description>
    <EndDateTime>2022-08-12T16:43:01.9160173-04:00</EndDateTime>
    <EstimatedHours>11</EstimatedHours>
    <LinkToListOfOpportunities>sample string 20</LinkToListOfOpportunities>
    <LinkToOpportunity>sample string 22</LinkToOpportunity>
    <Location>sample string 6</Location>
    <OpportunityAddress>sample string 24</OpportunityAddress>
    <OpportunityName>sample string 23</OpportunityName>
    <PictureUrl>sample string 21</PictureUrl>
    <Points>26</Points>
    <RequiresApproval>true</RequiresApproval>
    <SkillMultiplier>12</SkillMultiplier>
    <StartDateTime>2022-08-12T16:43:01.9160173-04:00</StartDateTime>
    <StatusText>sample string 16</StatusText>
    <Title>sample string 2</Title>
    <UpdatedOn>2022-08-12T16:43:01.9160173-04:00</UpdatedOn>
    <VolunteerOpportunityKey>d2fd607a-6dfe-4579-8abe-d4a6039d30ef</VolunteerOpportunityKey>
    <VolunteerOpportunityTypeKey>f60fb060-662d-4e7c-8d38-765e442aa545</VolunteerOpportunityTypeKey>
    <VolunteerSpotsAvailable>25</VolunteerSpotsAvailable>
    <VolunteersNeeded>7</VolunteersNeeded>
  </VolunteerOpportunity>
  <VolunteerOpportunity>
    <AdditionalRequirements>sample string 5</AdditionalRequirements>
    <ApplicationStatusText>sample string 18</ApplicationStatusText>
    <CloseDate>2022-08-12T16:43:01.9160173-04:00</CloseDate>
    <CreatedOn>2022-08-12T16:43:01.9160173-04:00</CreatedOn>
    <Deadline>sample string 4</Deadline>
    <Description>sample string 3</Description>
    <EndDateTime>2022-08-12T16:43:01.9160173-04:00</EndDateTime>
    <EstimatedHours>11</EstimatedHours>
    <LinkToListOfOpportunities>sample string 20</LinkToListOfOpportunities>
    <LinkToOpportunity>sample string 22</LinkToOpportunity>
    <Location>sample string 6</Location>
    <OpportunityAddress>sample string 24</OpportunityAddress>
    <OpportunityName>sample string 23</OpportunityName>
    <PictureUrl>sample string 21</PictureUrl>
    <Points>26</Points>
    <RequiresApproval>true</RequiresApproval>
    <SkillMultiplier>12</SkillMultiplier>
    <StartDateTime>2022-08-12T16:43:01.9160173-04:00</StartDateTime>
    <StatusText>sample string 16</StatusText>
    <Title>sample string 2</Title>
    <UpdatedOn>2022-08-12T16:43:01.9160173-04:00</UpdatedOn>
    <VolunteerOpportunityKey>d2fd607a-6dfe-4579-8abe-d4a6039d30ef</VolunteerOpportunityKey>
    <VolunteerOpportunityTypeKey>f60fb060-662d-4e7c-8d38-765e442aa545</VolunteerOpportunityTypeKey>
    <VolunteerSpotsAvailable>25</VolunteerSpotsAvailable>
    <VolunteersNeeded>7</VolunteersNeeded>
  </VolunteerOpportunity>
</ArrayOfVolunteerOpportunity>