GET Common BeefAPI Lookup Items

For the Recipe, BeefCut, and Collection search API endpoints, there are acceptable values used for the search parameters that represent specific values used to search for an item. Use the following helper call to identify the acceptable search parameter key-value pairs that can be passed to the search endpoints. The general data structure of each lookup object will have a *Name and a *NameSlug property. The search endpoint parameter searches accept the "NameSlug" properties and will be an exact match on those values. If you call the search API endpoint with a value that is not found in the common lookup models, unexpected results may be returned.

These same model values will also be returned as part of the larger objects when they are called. For example, when calling a the "Get single recipe by ID" endpoint, part of that object returned will be an array of attributes. This data structure matches the common/lookups attributes model, but will only return the attributes by type that are marked specifically for that ingredient. The same consistency is also true with other properties and sub properties of recipe allergens, collections, recipeType etc.

The base URI for the lookup items is:

GET /api/v2/common/lookups

What it Returns

Requests to the "GET Common BeefAPI lookup items" API will return the following data.

• BeefAPILookups object
  A container that holds the resulting API lookup arrays
  • allergens array
    A list of any allergens that this beef cut may contain
    • allergenName string
      Name of the allergen
    • allergenNameSlug string
      URL-friendly slugged name of the current allergen
  • attributesByTypes array
    A list of attributes by type that pertain to a beef cut or a recipe
    • 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
      • 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 attribute type
      • attributeName string
        Name of the attribute
      • attributeNameSlug string
        URL-friendly slugged name of the attribute
  • brands array
    A list of brands that may be used with a recipe ingredient
    • brandName string
      Name of the brand
    • brandNameSlug string
      URL-friendly name of the brand
  • collectionGroups array
    A list of groups to which a collection will belong
    • collectionGroupName string
      Name of the collection group
    • collectionGroupNameSlug string
      URL-friendly name of the collection group
    • objectType object
      The type object this attribute type pertains to
      • 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
  • collections array
    A list of collections available to the Beef API
    • collectionID int
      Unique identifier for the collection
    • collectionName string
      Unique name of the collection
    • collectionNameSlug string URL-friendly name of the collection
  • grocerySections array
    A list of grocery sections in which a beef cut can be found
    • grocerySectionName string
      The name of the grocery section
    • grocerySectionNameSlug string
      URL-friendly slugged name of te grocery section
  • ingredientGroups array
    A list of ingredient groups that a beef cut 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 the 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.")
    • ingredientGroupName string
      The name of the ingredient group
    • ingredientGroupNameSlug string
      URL-friendly slugged name of the ingredient group
  • ingredientTypes array
    A list of ingredient types in which a beef cut can be found
    • ingredientTypeName string
      The name of the ingredient type
    • ingredientTypeNameSlug string
      URL-friendly slugged name of the ingredient type
  • mediaGroups array
    Media will always be returned grouped and sorted. Use this grouping to help manage any groupings that may be suggested from the BeefAPI.
    • 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
      • objectTypeName string
        The name of the object type
      • objectTypeNameSlug string
        URL-friendly name of the object type
  • objectTypes array
    A list of types objects that can be found in the BeefAPI
    • objectTypeName string
      The name of the object type this collection pertains to
    • objectTypeNameSlug string
      The name of the object type this collection pertains to
  • audiences array
    A list of audiences found in the API
    • audienceName string
      Name of the recipe's intended audience
    • audienceNameSlug string
      URL-friendly name of the recipe's intended audience
  • primalIngredients array
    A list of primal beef cuts found in the API
    • ingredientID int
      The primal beef cut ingredient ID
    • ingredientName string
      The name of the primal beef cut ingredient
    • ingredientNameSlug string
      URL-friendly slugged name of the primal beef cut ingredient
  • beefIngredients array
    A list of beef cuts found in the API
    • ingredientID int
      The beef cut ingredient ID
    • ingredientName string
      The name of the beef cut ingredient
    • ingredientNameSlug string
      URL-friendly slugged name of the beef cut ingredient
  • usdaNutrients array
    A list of USDA nutrient objects that a recipe or beef cut will contain
    • usdaNutrientGroup string
      The food group of the nutrient
    • nutrientDisplayName string
      The display name of the nutrient
    • nutrientDisplayNameSlug string
      URL-friendly slugged display name of the nutrient