GET Recipe

Two similar endpoints can be used to fetch all the information about a single recipe. The endpoints differ by one parameter: one accepts a recipe ID, while the other accepts a recipe's slugged name.

The base URIs for the "Get Recipe By ID" and "Get recipe By Name" are:

GET /api/v2/recipe/{id}
GET /api/v2/recipe/{name}

Get Recipe By ID Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
id path integer
  This is a valid recipe ID

Get Recipe By Name Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
name path string
  Unique slugged name of the recipe

Both endpoints also accept the following parameters either in the query string or the request header.

Name Required Parameter Type Data Type
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 Recipe By ID" and "Get Recipe By Name" API will return the following data:

Name & Description Type
  • RecipeFull object
    A container that holds the resulting recipe information
    • 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
    • allergens array
      A complete unique list of all allergens that this recipe's ingredients may contain. Individual allergens per recipe ingredient can be found in the recipe ingredients array. Object values found in this array will be an exact match to what can be found in the master list of allergens in the common endpoint (/api/v2/common/lookups)
      • allergenName string
        Name of the allergen
      • allergenNameSlug string
        URL-friendly slugged name of the current allergen
    • attributes array
      A list of attributes by type that pertain to this recipe. Object values found in this array will be an exact match to what can be found in the master list of attributesByTypes in the common endpoint (/api/v2/common/lookups)
      • attributeTypeName string
        Name of the attribute type
      • attributeTypeNameSlug string
        URL-friendly slugged name of the attribute type
      • objectType object
        The type object this attribute type pertains to. Object values found in this array will be an exact match to what can be found in the master list of object type in the common endpoint (/api/v2/common/lookups)
        • objectTypeName string
          The name of the object type this attribute type pertains to
        • objectTypeNameSlug string
          URL-friendly slugged name of the type of object this attribute type pertains to
      • attributes array
        A list of attributes that pertain to this recipe attribute type
        • attributeName string
          Name of the attribute
        • attributeNameSlug string
          URL-friendly slugged name of the attribute
    • collections array
      A list of collections to which the recipe belongs. Object values found in this array will be an exact match to what can be found in the master list of collections in the common endpoint (/api/v2/common/lookups)
      • collectionID int
        Unique identifier for the collection
      • collectionName string
        Unique name of the collection
      • collectionNameSlug string
        URL-friendly name of the collection
      • collectionGroup object
        Contains information about the group to which the collection belongs. Object values found in this array will be an exact match to what can be found in the master list of collection groups in the common endpoint (/api/v2/common/lookups)
        • collectionGroupName string
          Name of the collection group
        • collectionGroupNameSlug string
          URL-friendly name of the collection group
        • objectType object
          The type object this collection 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 this collection group pertains to
          • objectTypeNameSlug string
            URL-friendly slugged name of the object type this collection group pertains to
      • objectType object
        The type object this collection 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 this collection pertains to
        • objectTypeNameSlug string
          URL-friendly slugged name of the object type this collection pertains to
      • links array
        A list of HATEOAS in relation to this collection. Typically if this collection is online, you will be provided with a link to the endpoint to get the full collection 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
    • ingredients array
      A list of all of the ingredients used to make the given recipe
      • subheading string
        Delineates groups of ingredients related to a specific part of a recipe
      • sortOrder int
        Defines the order of this ingredient in relation to others
      • ingredientText string
        General description of the ingredient
      • cookTip string
        Special tips for preparing the ingredient
      • brand object
        If populated, this is a specific brand of the ingredient used in this recipe. Object values found in this array will be an exact match to what can be found in the master list of brands in the common endpoint (/api/v2/common/lookups)
        • brandName string
          Name of the brand
        • brandNameSlug string
          URL-friendly slugged name of this brand
      • quantity string
        Quantity of the ingredient used in the recipe
      • weight string
        Weight of the ingredient used in the recipe
      • volume string
        Volume of the ingredient used in the recipe
      • ingredient object
        Contains various properties of the ingredient
        • ingredientID int
          Unique ID of the substitute ingredient
        • ingredientName string
          Name of the substitute ingredient
        • ingredientNameSlug string
          URL-friendly name of the substitute ingredient
        • isOnline boolean
          Defines the un/published status of the substitute ingredient
        • isBeefIngredient boolean
          Defines if ingredient is/not a derivative of a beef carcass
        • isLean boolean
          Defines if the ingredient has lean nutritional value
        • isBeefPrimal boolean
          Defines if ingredient is a beef primal from the carcass
        • isBeefSubprimal boolean
          Defines if the ingredient is a beef subprimal from the carcass
        • isBeefSubsection boolean
          Defines if the ingredient is a beef subsection from the carcass
        • isBeefFabricatedCut boolean
          Defines if the ingredient is a fabricated cut from the carcass
        • grocerySection array
          The section of a grocery store that you might find this ingredient. Object values found in this array will be an exact match to what can be found in the master list of grocery sections in the common endpoint (/api/v2/common/lookups)
          • grocerySectionName string
            Name of the grocery section
          • grocerySectionNameSlug string
            URL-friendly slugged name of the grocery section
        • ingredientType object
          The type of ingredient. Object values found in this array will be an exact match to what can be found in the master list of ingredient types in the common endpoint (/api/v2/common/lookups)
          • ingredientTypeName string
            Name of the ingredient type
          • ingredientTypeNameSlug string
            URL-friendly slugged name of the ingredient type
        • aliases array
          A list of other common or regional names that the given ingredient may also be called
          • aliasName string
            Another name for this beef cut
          • alsoKnownAsNameSlug string
            URL-friendly slugged name of the current alias
        • allergens array
          A list of all allergens that this ingredient may contain. Object values found in this array will be an exact match to what can be found in the master list of allergens in the common endpoint (/api/v2/common/lookups)
          • allergenName string
            Name of the allergen
          • allergenNameSlug string
            URL-friendly slugged name of the allergen
        • attributes array
          A list of attributes by type that pertain to this ingredient. Object values found in this array will be an exact match to what can be found in the master list of attributesByTypes in the common endpoint (/api/v2/common/lookups)
          • attributeTypeName string
            Name of the attribute type
          • attributeTypeNameSlug string
            URL-friendly name of the attribute type
          • objectType array
            The type object this attribute type pertains to. Object values found in this array will be an exact match to what can be found in the master list of object type in the common endpoint (/api/v2/common/lookups)
            • objectTypeName string
              The name of the object type this attribute type pertains to
            • objectTypeNameSlug string
              URL-friendly slugged name of the type of object this attribute type pertains to
          • attributes array
            A list of attributes that pertain to this ingredient attribute type
            • attributeName string
              Name of the attribute
            • attributeNameSlug string
              URL-friendly name of the attribute
        • ingredientGroups array
          A list of ingredient groups that this ingredient may belong to. Ingredient groups are used to manage ingredients that are considered synonyms. When retrieving a list of recipes, typically all the recipes will be returned for all teh ingredients in a group. An example group would be "Ground Beef", and it would include all the beef cuts ("83% Ground Beef, 95% Ground Beef, etc"). Object values found in this array will be an exact match to what can be found in the master list of ingredientGroups in the common endpoint (/api/v2/common/lookups)
          • ingredientGroupName string
            Name of the ingredient group
          • ingredientGroupNameSlug string
            URL-friendly slugged name of the ingredient group
        • links array
          A list of HATEOAS in relation to this ingredient. Typically if this ingredient is online, you will be provided with a link to the endpoint to get the full ingredient details. You will also be provided a link to get all the recipes that use this ingredient.
          • 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
        • media array
          A list of media objects containing information about media assigned to this ingredient
          • 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 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
              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
        • substituteIngredient array
          A list of ingredients that could used in place of the current ingredient
          • ingredientID int
            Unique ID of the substitute ingredient
          • ingredientName string
            Name of the substitute ingredient
          • ingredientNameSlug string
            URL-friendly name of the substitute ingredient
          • isOnline boolean
            Marker to denote if this ingredient is available on the Beef API
          • links array
            A list of HATEOAS in relation to this substitute ingredient. Typically if this ingredient is online, you will be provided with a link to the endpoint to get the full ingredient details. You will also be provided a link to get all the recipes that use this ingredient.
            • 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
      • recipeAsIngredient object
        Container used when this recipe ingredient is another recipe found in the API
        • recipeID int
          Unique ID of the recipe
        • recipeName string
          Name of the recipe
        • recipeNameSlug string
          URL-friendly slugged name of the recipe
        • isOnline boolean
          Marker to denote if this recipe is available on the Beef API
        • 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
        • 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
      • rollupIngredients array
        A list of ingredients that this recipe ingredients rolls up to. Ingredient rollups are used when one ingredient rolls into another ingredient. Typically this scenario is one ingredient rolls into a generic ingredient. Such as beef for kabobs, beef for stew, beef for stir fry etc.
        • ingredientID int
          Unique ID of the rollup ingredient
        • ingredientName string
          Name of the rollup ingredient
        • ingredientNameSlug string
          URL-friendly name of the rollup ingredient
        • isOnline boolean
          Marker to denote if this rollup ingredient is available on the Beef API
        • links array
          A list of HATEOAS in relation to this rollup ingredient. Typically if this rollup ingredient is online, you will be provided with a link to the endpoint to get the full rollup ingredient details. You will also be provided a link to get all the recipes that use this rollup ingredient.
          • 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
    • instructions array
      An ordered list of informational steps used to prepare the recipe
      • subheading string
        Delineates groups of instructions related to a specific part of a recipe
      • sortOrder int
        Defines the order of this instruction in relation to others
      • instructionText string
        Displayed text for the instruction
      • cookTip string
        Special tips for the instruction step
      • 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
    • 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
    • nutritionals array
      A list of nutritional information objects that pertain to this recipe
      • nutritionalDescription string
        Any extra descriptive information about this nutritional record
      • insignificantText string
        Information about any insignificant nutrients for the beef cut that are not large enough to have a nutritional impact in the calculated nutritionals.
      • dvDietBasisText string
        Information about the amount of calories used to calculate the daily value percentages
      • calorieDietBasisText string
        Information about the amount of calories used for the daily value calculation for calories
      • source string
        Information on where this nutritonal information was sourced from
      • isPrimary boolean
        Used to determine if this is the primary nutrional record from the list
      • nutrients array
        A list of the nutrients provided for the given nutritional record
        • 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
    • 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