GET / POST Search Recipe

Calls to this endpoint will return a list of the recipe summary objects.

This endpoint can be called via GET or POST. Calling the search via POST will check the body of the request for the search criteria:

GET /api/v2/recipe/search
POST /api/v2/recipe/search

Search Recipe Parameters

Try POST Endpoint Try GET Endpoint
Name Required Parameter Type Data Type
searchText (optional) path string
  The search will look for this text anywhere in the recipe model.
beefIngredients (optional) path array
  A list of beef ingredient ingredientNameSlug values that a recipe may contain. Values in this array must be an exact match to the common/lookups beefIngredients. Any values that are not an exact match to this field may return unexpected results.
collections (optional) path array
  A list of collections that the recipe may belong to. Values in this array must be an exact match to the common/lookups collections. Any values that are not an exact match to this field may return unexpected results.
cookingMethods (optional) path array
  A list of cooking methods that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='cooking-method'. Any values that are not an exact match to this field may return unexpected results.
cuisines (optional) path array
  A list of beef categories that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='cuisine'. Any values that are not an exact match to this field may return unexpected results.
excludeAllergens (optional) path array
  A list of allergens to exclude from the recipe search. Values in this array must be an exact match to the common/lookups allergens. Any values that are not an exact match to this field may return unexpected results.
mealCategories (optional) path array
  A list of cooking methods that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='meal-category'. Any values that are not an exact match to this field may return unexpected results.
menuCategories (optional) path array
  A list of cooking methods that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='menu-category'. Any values that are not an exact match to this field may return unexpected results.
audiences (optional) path array
  A list of recipe audiences that the recipe may belong to. Values in this array must be an exact match to the common/lookups audiences. Any values that are not an exact match to this field may return unexpected results.
recipeTypes (optional) path array
  A list of recipe types that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='recipe-type'. Any values that are not an exact match to this field may return unexpected results.
specialDiets (optional) path array
  A list of special diets that the recipe may be categorized as. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='special-diet'. Any values that are not an exact match to this field may return unexpected results.
goodNutritionals (optional) path array
  A list of nutrients that a recipes nutritional nutrient unitOfMeasureValue meets that USDA requirements for a "good" source. Values in this array must be an exact match to the common/lookups usdaNutrients. Any values that are not an exact match to this field may return unexpected results.
excellentNutritionals (optional) path array
  A list of nutrients that a recipes nutritional nutrient unitOfMeasureValue meets that USDA requirements for a "excellent" source. Values in this array must be an exact match to the common/lookups usdaNutrients. Any values that are not an exact match to this field may return unexpected results.
upcNumber (optional) path string
  Search for recipes that have an ingredient that is a matching Universal Product Code(UPC) number.
nampNumber (optional) path string
  Search for recipes that have an ingredient that is a matching NAMP number.
maxCookTimeMinutes (optional) path int
  Integer to set the maximum cook time in minutes of recipes that you are searching for.
maxNumberOfServings (optional) path int
  Integer to set the maximum number of servings of recipes that you are searching for.
isSpanishRecipe (optional) path boolean
  Search criteria to look for Spanish language recipes.
pageNumber (optional) path int
  Used in conjunction with the itemsPerPage parameter to manage paging in a search. This will default to page 1 if no value is provided.
itemsPerPage (optional) path int
  Used in conjunction with the pageNumber parameter to manage paging in a search. This will default to 10 if no value is provided. The maximum items per page is 50.
AuthorizationAppID (optional) query string
  This value must be present in either the http header or in the query string. If you supply an incorrect value or do not supply a value in the header or query string, then you will receive a http 401 error. (Please see Authentication section)
AuthorizationAppKey (optional) query string
  This value must be present in either the http header or in the query string. If you supply an incorrect value or do not supply a value in the header or query string, then you will receive a http 401 error. (Please see Authentication section)

What it Returns

Requests to the Search for a recipe will return the following data:

Name & Description Type
  • RecipeSearchResultModel object
    A container that holds the search result information
    • searchResults array
      A list of recipe summary objects
      • recipeID int
        Unique identifier of the recipe
      • recipeName string
        Name of the recipe
      • recipeNameSlug string
        URL-friendly slugged name of the recipe
      • isOnline boolean
        Defines the un/published status of the recipe
      • recipeMeta string
        Meta description of the recipe
      • recipeDescription string
        Description of the recipe
      • audience object
        Contains information about the intended recipe audience
        • audienceName string
          Name of the intended recipe audience
        • audienceNameSlug string
          URL-friendly name of the intended recipe audience
      • numberOfServings string
        Number of servings yielded by the recipe
      • maxNumberOfServingsInt int
        Integer value of the maximum number of servings
      • totalRecipeTime string
        Text value of the total time it takes to make the recipe.
      • maxTotalRecipeTimeMinutes int
        Integer value of the maximum total time it takes to make the recipe.
      • servingSize string
        Text value of the suggested serving size for a recipe.
      • prepTime string
        Text value of the recipe preparation time.
      • maxPrepTimeMinutes int
        Integer value of the maximum recipe preparation time.
      • cookTime string
        Text value of the recipe cook time.
      • maxCookTimeMinutes int
        Integer value of the maximum recipe cook time.
      • isSpanishRecipe boolean
        Defines whether the recipe text is in Spanish
      • showcaseNutrients array
        A list of nutrients from this recipe's primary nutritional that we suggest to highlight
        • usdaNutrient object
          The USDA nutrient object for the given nutrient. Object values found in this array will be an exact match to what can be found in the master list of usdaNutrients in the common endpoint (/api/v2/common/lookups)
          • usdaNutrientGroup string
            The food group of the nutrient
          • nutrientDisplayName string
            The display name of the nutrient
          • nutrientDisplayNameSlug string
            URL-friendly slugged name of the nutrient
        • unitOfMeasureValue decimal
          The calculated unit of measure for the given nutrient
        • unitOfMeasure string
          The unit of measure for the given nutrient
        • dailyValueCalculation decimal
          The calculated daily value for this nutrient
        • sortOrder int
          The preferred sort order for display of this nutrient
        • isGoodSource boolean
          If the unitOfMeasureValue meets that USDA requirements for a "good" source of the given nutrient, this field will be true, else it will be false
        • isExcellentSource boolean
          If the unitOfMeasureValue meets that USDA requirements for an "excellent" source of the given nutrient, this field will be true, else it will be false
      • media array
        A list of media objects containing information about media assigned to this recipe instruction
        • widenURL string
          This is the base part of the URL that is needed to build the embed link
        • widenUID string
          This is the customer userid part of the URL that is needed to build the embed link
        • externalID string
          This is the unique identifier of the media item
        • filename string
          This is the filename of the media item
        • title string
          This is the title of the media item
        • caption string
          This is the caption used for the media item
        • mediaGroup array
          Media will always be returned grouped and sorted. Use this grouping to help manage any groupings that may be suggested from the BeefAPI. Object values found in this array will be an exact match to what can be found in the master list of mediaGroups in the common endpoint (/api/v2/common/lookups)
          • mediaGroupName string
            Name of the media group
          • mediaGroupNameSlug string
            URL-friendly slugged name of the media group
          • objectType array
            The type object this media group pertains to. Object values found in this array will be an exact match to what can be found in the master list of objectTypes in the common endpoint (/api/v2/common/lookups)
            • objectTypeName string
              The name of the object type
            • objectTypeNameSlug string
              URL-friendly name of the object type
          • mediaType string
            The type of media returned
          • sortOrder int
            The suggested sort order to be used for this media item
          • links array
            A list HATEOAS for this media item that is a link to view the media in its original size
            • rel string
              The rel attribute specifies the relationship between the current document and the linked document
            • href string
              URI of the beefapi call to get more information for this links' context
            • title string
              Title of the link
      • links array
        A list of HATEOAS in relation to this recipe. Typically if this recipe is online, you will be provided with a link to the endpoint to get the full recipe details.
        • rel string
          The rel attribute specifies the relationship between the current document and the linked document
        • href string
          URI of the beefapi call to get more information for this links' context
        • title string
          Title of the link
    • searchCriteria object
      An object representing the search parameters that were passed into the search recipes API call.
      • searchText string
        The search will look for this text anywhere in the recipe model.
      • beefIngredients array
        A list of ingredientNameSlug values that a recipe may be a descendent of. Values in this array must be an exact match to the common/lookups beefIngredients. Any values that are not an exact match to this field may return unexpected results.
      • collections array
        A list of collections that the recipe may belong to. Values in this array must be an exact match to the common/lookups collections. Any values that are not an exact match to this field may return unexpected results.
      • cookingMethods array
        A list of cooking methods that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='cooking-method'. Any values that are not an exact match to this field may return unexpected results.
      • cuisines array
        A list of beef categories that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='cuisine'. Any values that are not an exact match to this field may return unexpected results.
      • excludeAllergens array
        A list of allergens to exclude from the recipe search. Values in this array must be an exact match to the common/lookups allergens. Any values that are not an exact match to this field may return unexpected results.
      • mealCategories array
        A list of cooking methods that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='meal-category'. Any values that are not an exact match to this field may return unexpected results.
      • menuCategories array
        A list of cooking methods that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='menu-category'. Any values that are not an exact match to this field may return unexpected results.
      • audiences array
        A list of recipe audiences that the recipe may belong to. Values in this array must be an exact match to the common/lookups audiences. Any values that are not an exact match to this field may return unexpected results.
      • recipeTypes array
        A list of recipe types that the recipe may contain. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='recipe-type'. Any values that are not an exact match to this field may return unexpected results.
      • specialDiets array
        A list of special diets that the recipe may be categorized as. Values in this array must be an exact match to the common/lookups AttributesByTypes model attributes.attributeNameSlug array where the attributeTypeNameSlug='special-diet'. Any values that are not an exact match to this field may return unexpected results.
      • goodNutritionals array
        A list of nutrients that a recipes nutritional nutrient unitOfMeasureValue meets that USDA requirements for a "good" source. Values in this array must be an exact match to the common/lookups usdaNutrients. Any values that are not an exact match to this field may return unexpected results.
      • excellentNutritionals array
        A list of nutrients that a recipes nutritional nutrient unitOfMeasureValue meets that USDA requirements for a "excellent" source. Values in this array must be an exact match to the common/lookups usdaNutrients. Any values that are not an exact match to this field may return unexpected results.
      • upcNumber string
        Search for recipes that have an ingredient that is a matching Universal Product Code(UPC) number.
      • nampNumber string
        Search for recipes that have an ingredient that is a matching IMPS/NAMP number.
      • maxCookTimeMinutes int
        Integer to set the maximum cook time in minutes of recipes that you are searching for.
      • maxNumberOfServings int
        Integer to set the maximum number of servings of recipes that you are searching for.
      • isSpanishRecipe boolean
        Search criteria to look for Spanish language recipes.
      • pageNumber int
        Used in conjunction with the itemsPerPage parameter to manage paging in a search. This will default to page 1 if no value is provided.
      • itemsPerPage int
        Used in conjunction with the pageNumber parameter to manage paging in a search. This will default to 10 if no value is provided. The maximum items per page is 50.
    • totalCount int
      Estimated total count of items that match the search criteria
    • curPage int
      The current page of the search results
    • itemsPerPage object
      The current items per page used in returning the search results
    • links array
      A list of HATEOAS in relation to this search call.
      • rel string
        The rel attribute specifies the relationship between the current document and the linked document
      • href string
        URI of the beefapi call to get more information for this links' context
      • title string
        Title of the link