GET Recipes By List

Calls to this endpoint will return a summary list of recipes based on a given list of recipe IDs

The base URI for Get recipes by list is

GET /api/v2/recipe/list

Get Recipes By List Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
recipeIDList path array
  An array or comma delimited list of recipe IDs. These values must be integers.
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 GET recipes by list will return the following data:

Name & Description Type
  • BeefAPIRecipeSummaryListing object
    A container that holds the resulting list of recipes
    • recipeListing 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
        Contains information about media assigned to the ingredient
        • widenURL string
          Widen asset URL for the media item
        • widenUID string
          Widen unique user ID used to access the media repository
        • externalID string
          Widen unique asset identifier for the media item
        • filename string
          Widen filename for the media item
        • title string
          Widen title for the media item
        • caption string
          Widen caption for the media item
        • mediaGroup object
          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 object
            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
            Defines the type of the media item
          • sortOrder int
            Defines the order of the media item in relation to others
          • 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