GET Recipe Collection

Two similar endpoints can be used to fetch all the information about a single recipe 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 Recipe By Collection ID" and "Get Recipe Collection By Name" are:

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

Get Recipe Collection By ID parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
id path int
  A valid recipe collection ID

Get Recipe Collection By Name Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
name path string
  A valid slugged recipe 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 Recipe By Collection ID" and "Get Recipe Collection By Name" API will return the following data.

Name & Description Type
  • CollectionSummaryWithIngredients object
    Container 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, consise description of the collection
    • description string
      Text used to describes the contents and use of the collection
    • estimatedItemCount int
      an estimated count of recipes 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
    • recipes array
      A sorted list of recipe summary objects that are part of this collection
      • sortOrder int
        The suggested sort order to be used for this recipe when displaying the list of recipes that belong to this collection
      • 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 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 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