GET Beef Cut Collection

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

The base URIs for the "Get Beef Cut By Collection ID" and "Get Beef Cut Collection By Name" are:

GET /api/v2/beefcut/collection/{id}
GET /api/v2/beefcut/collection/{name}

Get Beef Cut Collection By ID Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
id path integer
  A valid beef cut collection ID

Get Beef Cut Collection By Name Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
name path string
  A valid slugged beef cut collection name

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 Beef Cut By Collection ID" and "Get Beef Cut Collection By Name" API will return the following data:

Name & Description Type
  • CollectionSummaryWithIngredients object
    ontainer that holds the collection and ingredients information.
    • collectionID int
      Unique identifier of the collection.
    • collectionName string
      Name of the collection.
    • collectionNameSlug string
      URL-friendly slugged 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 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.
    • tagline string
      Short, concise description of the collection.
    • description string
      Text used to describes the contents and use of the collection.
    • estimatedItemCount int
      An estimated count of beef cuts that are included in this collection.
    • media array
      A list of media objects containing information about media assigned to this collection.
      • 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.
    • 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 sorted list of ingredient summary objects that are part of this collection.
      • sortOrder int
        The suggested sort order to be used for this beef cut ingredient when displaying the list of beef cut ingredients that belong to this collection.
      • ingredientID int
        Unique identifier of the beef cut.
      • ingredientName string
        Name of the beef cut.
      • ingredientNameSlug string
        URL-friendly slugged name of the beef cut.
      • isOnline boolean
        Marker to denote if this beef cut is available on the Beef API.
      • lastModified datetime
        Date & time the object was last updated
      • ingredientText string
        General description of the beef cut.
      • ingredientMeta string
        Short, concise meta description of the beef cut.
      • isBeefIngredient boolean
        True if this is a beef ingredient.
      • isBeefPrimal boolean
        True if this is a primal beef cut.
      • isBeefSubprimal boolean
        True if this is a subprimal beef cut.
      • isBeefSubsection boolean
        True if this is a subsection beef cut.
      • isBeefFabricatedCut boolean
        True if this is a fabricated beef cut.
      • isLean boolean
        True if this is a lean beef cut.
      • isMarinate boolean
        True if this beef cut is suggested to marinate.
      • isRecipeIngredient boolean
        True if this beef cut is used in recipes.
      • grocerySection array
        The grocery section this beef cut can be found in. Object values found in this array will be an exact match to what can be found in the master list of grocerySections 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 ingredientTypes 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.
      • showcaseNutrients array
        A list of nutrients from this beef cuts primary nutritional that we suggest to highlight.
        • nutritionalType string
          The type of nutritional. This will be "raw" or "cooked."
        • 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 of HATEOAS in relation to this beef cut. Typically if this beef cut is online, you will be provided with a link to the endpoint to get the full beef cut details. You will also be provided a link to get all the recipes that use this beef cut.
        • 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.
      • attributes array
        A list of attributes by type that pertain to this beef cut. 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 beef cut attribute type.
          • attributeName string
            Name of the attribute.
          • attributeNameSlug string
            URL-friendly name of the attribute.
      • media array
        A list of media objects containing information about media assigned to this beef cut.
        • 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.