INPUT_OBJECT

SRPParamsInput

link GraphQL Schema definition

  • input SRPParamsInput {
  • # Search by the opportunity's cause categories
  • categories: [Category]
  • # VolunteerMatch Internal Use Only. An array of collection ids. This is used to
  • # limit the search to opportunities linked to the given collection. Currently,
  • # only one collection is allowed.
  • collectionIds: [Int]
  • # Defines how a user can participate in this opportunity
  • connectionType: OpportunityConnectionType
  • containerIds: [Long]
  • # The name or id of a container. This is used to limit the search to
  • # opportunities linked to the given container. Currently, only one container is
  • # allowed.
  • containers: [String]
  • # Id for custom query to use
  • customKeywordQueryId: String
  • # Search for opportunities that start and/or end on certain dates, as well as ones
  • # on-going without specific start and end dates
  • dateRanges: [DateRangeDetailInput]
  • # User enter an array of Strings. This is a text search against opportunities's
  • # description, i.e., descriptions: ["girls","boys"]
  • descriptions: [String]
  • doneInADay: Boolean
  • # User enter an array of Strings. This is a text search against opportunities's
  • # parent Organization's EIN, i.e., eins: ["123456789","12-3456789"]
  • eins: [String]
  • forceRecalculate: Boolean
  • # Search opportunities are friendly for these groups of people, including kids,
  • # teens, seniors, groups and doneInADay
  • greatFor: [GreatFor]
  • # Search Opportunities by an array of opportunity IDs
  • ids: [Int]
  • includePrivateGroupsOnly: Boolean
  • # Set to false if we don't want to include regional/national opportunities.
  • # Default is true
  • includeRegional: Boolean
  • # User enter an array of Strings. This is a keyword search against opportunities's
  • # title, org name, description, skills, and categories, i.e., keywords:
  • # ["girls","boys"]
  • keywords: [String]
  • limitOppsPerOrg: Boolean
  • # Free-form text to indicate location, i.e., location: "san francisco", or
  • # location: "94111", or location: "GB". Use "Non-US" to query for opportunities
  • # located in all non-US countries
  • location: String
  • numberOfResults: Int
  • # An array of Organization IDs to search by
  • orgIds: [Int]
  • # User enter an array of Strings. This is a text search against opportunities's
  • # parent Organization names, i.e., orgNames: ["girls","boys"]
  • orgNames: [String]
  • orgPageSearch: Boolean
  • # The page number of the search result
  • pageNumber: Int
  • pageSortCriteria: SortSRPBy
  • # An array of opportunities's parent organization's National or multi-chapter
  • # organization IDs
  • partners: [Int]
  • # The supported search radius values are: a number(in miles), city,
  • # subregion(county), msa, region(state), country
  • radius: String
  • # Set this field to true to query for opportunities that have a redirect link,
  • # false to filter out all opportunities with redirect links. Omit this field if
  • # no filtering based on redirect link is desired.
  • redirectOpps: Boolean
  • # Set this field to true to query for both virtual and on-location opportunities
  • # based on Location input. This input is ignored if you’ve set virtual = true
  • returnVirtualAndOnSiteOpps: Boolean
  • searchOption: SearchOption
  • # User enter an array of Strings. This is a text search against opportunities's
  • # needed skills, i.e., skills: ["computer","child care"]
  • skills: [String]
  • # An array of container names used when sortCriteria is set to "container".
  • # Opportunities will be sorted according to the order of these containers. Contact
  • # VolunteerMatch for valid container names.
  • sortByContainers: [String]
  • # The sort criteria for the search result, if non specified, the default is
  • # 'distanceBand'
  • sortCriteria: SortBy
  • # The the sort order of the search result. Supported values: asc or desc
  • sortOrder: SortOrder
  • # The special flag tagged to this opportunity, currently only covid19 is supported
  • specialFlag: 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
  • # Search for opportunities updated on or after a certain date
  • updatedSince: String
  • # Set to true if we want to include opportunities without a location
  • virtual: Boolean
  • # Allows filtering of virtual opportunities by the region the organization is
  • # located in. Ignored if virtual is false or omitted. Free-form organization
  • # region text, i.e., virtualOrgRegion: "CA", or virtualOrgRegion: "94111". For
  • # US-based locations, region will always resolve to a state.
  • virtualOrgRegion: String
  • }

link Require by