GET All Recipes

Calls to this endpoint will return a list of all the recipes that are available via the API.

The base URI for list all recipes is:

GET /api/v2/recipe

Get All Recipes Parameters

Try This Endpoint on Swagger
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 GET all recipes will return the following data:

Name & Description Type
  • BeefAPIRecipeList object
    A container that holds the resulting list of recipes
    • recipeList array
      Contains basic details for all recipes available in the APIs
      • 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