--- schema_version: "1" id: 43323a90569ad32fea91c7de89f2d917ba6cfc3dd1ae370e29d5076177b5d5d6 title: Recipes List Resource collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/salesforce_recipes_api/sforce_recipes_api_resources_recipes.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_resources_recipes.htm source_site: developer.salesforce.com content_type: documentation content_hash: 728e653780700c4892c73f2eae62830eed664b219a217ea465b52e904d53e733 description: Returns a collection of Data Prep recipes and creates a recipe. --- # Recipes List Resource Returns a collection of Data Prep recipes and creates a recipe. ## Resource URL /wave/recipes ## Formats JSON ## Available Version 38.0 ## Available in Postman To view and test a working example of this resource, see [getRecipeCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-a6ecbe75-38d5-455b-9b28-505ad8d28819?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quickstart](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "HTML (New Window)"). ## Available Components - LWC — [lightning/analyticsWaveApi getRecipes()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-recipes.html) ## HTTP Methods GET ## Request Parameters for GET
Parameter Name Type Description Required or Optional Available Version
folder​Id Id Returns a collection filtered by recipes belonging to the specified folder ID. Optional 61.0
format Connect​Recipe​Format​Type​Enum Returns a collection filtered by the format of the current recipe definition. Valid values are:
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
Optional 48.0
last​Modified​After String Returns a collection filtered by recipes with a last modified date after the given value. Optional 55.0
last​Modified​Before String Returns a collection filtered by recipes with a last modified date before the given value. Optional 55.0
license​Type Connect​Analytics​License​Type​Enum Filters the collection by the Analytics license type. Valid values are
  • Cdp (Data 360)
  • Data​Pipeline​Query (Data Pipeline Query)
  • Einstein​Analytics (CRM Analytics)
  • Intelligent​Apps (Intelligent Apps)
  • Mulesoft​Data​Path (Mulesoft Data Works)
  • Sonic (Salesforce Data Pipeline)
Optional 52.0
next​Scheduled​After String Returns a collection filtered by recipes with a scheduled run after the given value. Optional 55.0
next​Scheduled​Before String Returns a collection filtered by recipes with a scheduled run before the given value. Optional 55.0
page String A generated token that indicates the view of the objects to be returned. Optional 38.0
page​Size Int Number of items to be returned in a single page. Minimum is 1, maximum is 200, and the default is 25. Optional 38.0
q String Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. Optional 38.0
sort Connect​Wave​Sort​Order​Type​Enum The type of sort order to be applied to the returned collection. Valid values are:
  • App
  • Created​By
  • Created​By​Id
  • Created​Date
  • Folder​Name
  • Last​Modified
  • Last​Modified​By
  • Last​Modified​By​Id
  • Last​Modified​Date
  • Location
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Outcome
  • Refresh​Date (for assets like datasets)
  • Run​Date (for assets like reports)
  • Status
  • Title
  • Type
 Optional 38.0
status Connect​Recipe​Status​Enum[] Returns a collection filtered by the statuses of the recipe. Valid values are:
  • Cancelled
  • Failure
  • New (Never run or has no recent run)
  • Queued
  • Running
  • Success
  • Warning
 Optional 55.0
The following REST URL shows how to use the q parameter as a search query in the GET request. /wave/recipes?q=MyRecipe ## Response Body for GET [Recipe Collection](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_recipe_collection.htm "A collection of data prep recipes.") ![Important](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/images/icon_note_important.png) #### Important Recipes require the recipe editor UI for creation and aren’t supported using POST via this API endpoint.