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

Returns Upcoming VolunteerOpportunies for Current User.

Request Information

URI Parameters

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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.	Community	None.
RequiresApproval	Indicates whether the Volunteer Opportunity requires approval by an administrator. **Note that at this time, only Volunteer Opportunities where this value is FALSE can be Volunteered for via the API.	boolean	None.
Status	Enumeration for the Volunteer Opportunity's Status. May be null. See the Status Object documentation for additional information about possible values.	Status	None.
StatusText	The Volunteer Opportunity's Status.	string	None.
CanSignUpViaApi	Tells whether a user can Volunteer for this Opportunity via the API.	boolean	None.
ApplicationStatus	The status of the Volunteer Opportunity Application/Sign-up for the current user.	VolunteerApplicationStatuses	None.
ApplicationStatusText	The Application Status text.	string	None.
VolunteerOpportunityTypeKey	Indicates the opportunity type that the Volunteer Opportunity is associated with	globally unique identifier	None.
LinkToListOfOpportunities	Link to reach the volunteer opportunities page	string	None.
PictureUrl	Thumbnail image src associated to Volunteer Opportunity	string	None.
LinkToOpportunity	Link to reach the specific Volunteer Opportunity	string	None.
OpportunityName	Name of the Volunteer Opportunity	string	None.
OpportunityAddress	Exact Address for the Volunteer Opportunity	string	None.
VolunteerSpotsAvailable	The number of volunteer spots that are left for the Volunteer Opportunity	integer	None.
Points	The total points that will be awarded to the Volunteer for the Volunteer Opportunity	integer	None.
VolunteerOpportunityIntegrationCode	The unique AMS code for this Volunteer Opportunity	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "VolunteerOpportunityKey": "2a3a6301-2267-4207-9d1a-b0fde0c33d5e",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "Deadline": "sample string 4",
    "AdditionalRequirements": "sample string 5",
    "Location": "sample string 6",
    "VolunteersNeeded": 7,
    "CreatedOn": "2022-12-04T21:34:08.9948731Z",
    "CloseDate": "2022-12-04T21:34:08.9948731Z",
    "UpdatedOn": "2022-12-04T21:34:08.9948731Z",
    "EstimatedHours": 11.0,
    "SkillMultiplier": 12.0,
    "StartDateTime": "2022-12-04T21:34:08.9948731Z",
    "EndDateTime": "2022-12-04T21:34:08.9948731Z",
    "Community": null,
    "RequiresApproval": true,
    "Status": 0,
    "StatusText": "sample string 16",
    "CanSignUpViaApi": true,
    "ApplicationStatus": 0,
    "ApplicationStatusText": "sample string 18",
    "VolunteerOpportunityTypeKey": "5e83cfe1-b949-4ffe-9680-d45cdcdf839f",
    "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": "2a3a6301-2267-4207-9d1a-b0fde0c33d5e",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "Deadline": "sample string 4",
    "AdditionalRequirements": "sample string 5",
    "Location": "sample string 6",
    "VolunteersNeeded": 7,
    "CreatedOn": "2022-12-04T21:34:08.9948731Z",
    "CloseDate": "2022-12-04T21:34:08.9948731Z",
    "UpdatedOn": "2022-12-04T21:34:08.9948731Z",
    "EstimatedHours": 11.0,
    "SkillMultiplier": 12.0,
    "StartDateTime": "2022-12-04T21:34:08.9948731Z",
    "EndDateTime": "2022-12-04T21:34:08.9948731Z",
    "Community": null,
    "RequiresApproval": true,
    "Status": 0,
    "StatusText": "sample string 16",
    "CanSignUpViaApi": true,
    "ApplicationStatus": 0,
    "ApplicationStatusText": "sample string 18",
    "VolunteerOpportunityTypeKey": "5e83cfe1-b949-4ffe-9680-d45cdcdf839f",
    "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-12-04T16:34:08.9948731-05:00</CloseDate>
    <CreatedOn>2022-12-04T16:34:08.9948731-05:00</CreatedOn>
    <Deadline>sample string 4</Deadline>
    <Description>sample string 3</Description>
    <EndDateTime>2022-12-04T16:34:08.9948731-05: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-12-04T16:34:08.9948731-05:00</StartDateTime>
    <StatusText>sample string 16</StatusText>
    <Title>sample string 2</Title>
    <UpdatedOn>2022-12-04T16:34:08.9948731-05:00</UpdatedOn>
    <VolunteerOpportunityKey>2a3a6301-2267-4207-9d1a-b0fde0c33d5e</VolunteerOpportunityKey>
    <VolunteerOpportunityTypeKey>5e83cfe1-b949-4ffe-9680-d45cdcdf839f</VolunteerOpportunityTypeKey>
    <VolunteerSpotsAvailable>25</VolunteerSpotsAvailable>
    <VolunteersNeeded>7</VolunteersNeeded>
  </VolunteerOpportunity>
  <VolunteerOpportunity>
    <AdditionalRequirements>sample string 5</AdditionalRequirements>
    <ApplicationStatusText>sample string 18</ApplicationStatusText>
    <CloseDate>2022-12-04T16:34:08.9948731-05:00</CloseDate>
    <CreatedOn>2022-12-04T16:34:08.9948731-05:00</CreatedOn>
    <Deadline>sample string 4</Deadline>
    <Description>sample string 3</Description>
    <EndDateTime>2022-12-04T16:34:08.9948731-05: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-12-04T16:34:08.9948731-05:00</StartDateTime>
    <StatusText>sample string 16</StatusText>
    <Title>sample string 2</Title>
    <UpdatedOn>2022-12-04T16:34:08.9948731-05:00</UpdatedOn>
    <VolunteerOpportunityKey>2a3a6301-2267-4207-9d1a-b0fde0c33d5e</VolunteerOpportunityKey>
    <VolunteerOpportunityTypeKey>5e83cfe1-b949-4ffe-9680-d45cdcdf839f</VolunteerOpportunityTypeKey>
    <VolunteerSpotsAvailable>25</VolunteerSpotsAvailable>
    <VolunteersNeeded>7</VolunteersNeeded>
  </VolunteerOpportunity>
</ArrayOfVolunteerOpportunity>