Page Comparison

title: String

• Description: The title of the opportunity.

description: String

• Description: The description of the opportunity. Supports basic HTML for formatting, including elements like <div>, <ul>, <p>, <br>, <li>, and <ol>.

plainTextDescription: String

• Description: The description of the opportunity description with no HTML tags.

parentOrg: OrganizationDetail (Link to OrganizationDetail Schema)

• Description: The organization to which this opportunity belongs.

• Usage: Contains details about the parent organization. Refer to OrganizationDetail for the structure and information provided.

  • Recommend fields to display in OrganizationDetail:

    • name: String

      • Description: Name of this organization

  • Optional fields to display in OrganizationDetail:

    • url: String

      • Description: The URL of this organization on the VolunteerMatch website

dateRange: DateRangeDetail (Link to DateRangeDetail Schema)

• Recommend fields to display in DateRangeDetail:

  • ongoing: Boolean

    • Description: If true, the opportunity does not have start and end dates, and the dates are flexible. startDate, endDate fields will return Null.

    • Usage: If true, we recommend you let the user know that the dates for this opportunity are flexible.

  • startDate: String

    • Description: The start date of the opportunity, formatted as "yyyy-MM-dd".

  • startTime: String

    • Description: The start time of the opportunity, formtted as "hh:mm" or "hh:mmaa"

  • endDate: String

    • Description: The end date of the opportunity, formatted as "yyyy-MM-dd".

  • endTime: String

    • Description: The end time of the opportunity, formtted as "hh:mm" or "hh:mmaa"

location: LocationDetail (Link to LocationDetail Schema)

• Recommend fields to display in LocationDetail:

  • street1: String

  • street2: String

  • city: String

  • region: String

  • country: String

  • postalCode: String

categories: List ofCategoriesenum(Link to Categories Enum)

• Description: A list of 1 to 3 cause categories associated with the opportunity. Each opportunity has at least one cause category and can have a maximum of three.

skillsNeeded: String

• Description: The skills required for the opportunity, listed in plain text and separated by commas. To view a full list of skills, refer to the Skills Enum Documentation.

greatFor: List ofgreatForenum(Link to GreatFor Enum)

• Description: Categorizes opportunities based on the target audience, as determined by the nonprofit admin. For a complete list of available enum values, refer to the GreatFor Enum Documentation.

groupSize: String

• Description: The required group size for the opportunity. Must be one of the following values: 5, 10, 20, or 10000.

timeCommitment: String

• Description: The time commitment required for the opportunity, described in plain text.

• Usage: One of the requirement fields

timeslots: List of timeslots enum (Link to Timeslot Enum)

• Description: When the volunteer opportunity is available based on timeslot selections.

requirements: RequirementsBean (Links to RequirementsBean Schema)

• Description: The specific requirements for volunteering for this opportunity.

• Usage: One of the requirement fields

• Fields included in RequirementsBean

  • bgCheck: Boolean

    • Description: Indicates if a background check is required.

  • drLicense: Boolean

    • Description: Indicates if a driver's license is required.

  • minimumAge: Integer

    • Description: The minimum age required to volunteer.

  • orientation: Boolean

    • Description: Indicates if orientation is required before volunteering.

otherRequirements: String

• Description: Any additional requirements or conditions not covered by the standard fields.

id:Integer

• Description: The unique identifier for the opportunity assigned by VolunteerMatch.

• Usage: This field does not need to be displayed but should be stored or passed along to facilitate future connections or actions related to the opportunity.

The following fields are only available when shift-related opportunities are enabled by the VolunteerMatch Opportunities Type Restriction.

• oppActiveShifts: List of ShiftDetail objects (Links to ShiftDetail Schema)

  • Description: A list of active shifts for the opportunity that are currently available for volunteers. This field only includes shifts that have not yet expired.

  • Usage: Display these shifts to users when showing opportunities with currently available shifts for participation.

• shifts: List of ShiftDetail objects (Links to ShiftDetail Schema)

  • Description: A list of all shifts for the opportunity, including both active and expired shifts.

  • Usage: This field can be used for reporting or administrative purposes where visibility of all shifts, regardless of their status, is necessary.