OBJECT

OpportunityDetail

link GraphQL Schema definition

  • type OpportunityDetail {
  • # 1 to 3 cause categories of this opportunity
  • categories: [Category]!
  • # The type of connection a volunteer could make to an opportunity. Once an
  • # opportunity is created in VolunteerMatch, changing connectionType is not
  • # allowed. By default, VolunteerMatch saves all new opportunities with
  • # connectionType of "express interest."
  • connectionType: OpportunityConnectionType
  • # The container this opportunity is grouped in
  • container: String
  • # The origin or source of this opportunity. If this field is not used,
  • # VolunteerMatch will default set an opportunity’s origin based on the actor ID
  • # associated with your API key. After an opportunity is created, updating this
  • # field is not allowed.
  • contentSource: String
  • # The special flag tagged to this opportunity, currently only covid19 is supported
  • covidRelated: Boolean
  • # The custom questions this opportunity ask the volunteers to fill out
  • customFields: [CustomFieldDetail]
  • # Date posted
  • datePosted: String
  • # opportunity date range
  • dateRange: DateRangeDetail!
  • # The opportunity description. Supports some basic HTML for formatting, supported
  • # elements include div,ul,p,br,li,ol
  • description: String
  • # Opportunity's expiration date
  • expiration: String
  • # Externally provided unique identifier for the opportunity, for opportunities
  • # originating from an external source
  • externalId: String
  • # The group of people this opportunity is friendly for
  • greatFor: [GreatFor]
  • # opportunity GroupSize, needs to numeric value"
  • groupSize: String
  • # VolunteerMatch's unique identifier for the opportunity
  • id: Int
  • # The URL for this opportunity's profile image (if any)
  • imageUrl: String
  • # The date this opportunity was last updated
  • lastUpdated: String
  • # opportunity location
  • location: LocationDetail!
  • minGroupSize: String
  • oppActiveShifts: [ShiftDetail]
  • # The connection type
  • otherRequirements: String
  • # The organization this opportunity belongs to
  • parentOrg: OrganizationDetail
  • # opportunity description with no HTML tags
  • plaintextDescription: String
  • privateGroup: PrivateGroupDetail
  • # This URL directs volunteers to an external site to connect with the organization
  • # that published this opportunity. It is not a 'passthrough' connectionType and
  • # can only be added or edited by pro members. The URL must start with http:// or
  • # https://.
  • redirectOppUrl: String
  • # This is the URL that leads volunteers to an external site in order to connect
  • # with the organization who published this opportunity. An opportunity must have
  • # connectionType of “passthrough” in order for this field to take effect. This URL
  • # must starts with http:// or https://
  • redirectUrl: String
  • # The requirements to volunteer for this opportunity
  • requirements: RequirementsBean
  • rsvpDetail: RSVPDetail
  • saveType: SaveType
  • shiftOrTimeslot: ShiftOrTimeslot
  • # The shifts of this opportunity
  • shifts: [ShiftDetail]
  • # The skills needed for this opportunity in plain text, comma separated
  • skillsNeeded: String
  • # Deprecated, will be removed in the future.The special flag tagged to this
  • # opportunity, currently only covid19 is supported
  • specialFlag: [String]
  • # The opportunity keywords entered by its administrator
  • tags: [String]
  • # Time commitment
  • timeCommitment: String
  • # Represents checkboxes with four options: daytimeWeekdays, daytimeWeekends,
  • # eveningWeekdays and eveningWeekends. Only the selected options are input and
  • # displayed.
  • timeslots: [Timeslot]
  • # opportunity title
  • title: String!
  • # The VolunteerMatch website URL for this opportunity
  • url: String
  • # The number of volunteers this opportunity needs
  • volunteersNeeded: Int!
  • }