# List Recipes

> `UiPath.Workato.Activities.ListRecipes`

`UiPath.Workato.Activities.ListRecipes`

The **List Recipes** activity uses the Workato [List recipes belonging to user](https://docs.workato.com/workato-api/recipes.html#list-recipes-belonging-to-user) API, to retrieve the list of active or non-active recipes (**Active**) that belong to the user specified in the [Workato Scope](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-scope) activity. This activity also gives you the ability to narrow your results by filter criteria.

After completing the get operation, the activity outputs the relevant recipes in a `Recipe[]` object (**Recipes**) that you can use as an input variable in subsequent activities (e.g., `Recipe(0).Id` in [Start Recipe](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-start-recipe), [Stop Recipe](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-stop-recipe)).

## How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the [Setup](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-setup) steps.
2. Add the [Workato Scope](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-scope) activity to your project.
3. Add the **List Recipes** activity inside the **Workato Scope** activity.
4. Enter values for the [Input](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-list-recipes#list-recipes) properties.
5. Create and enter a `Recipe[]` variable for the [Output](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-list-recipes#list-recipes) property.
6. Create and enter a `ResponseStatus` variable for the [Output](https://docs.uipath.com/activities/other/latest/legacy-integrations/successfactors-get-record) property.

## In the Body of the Activity

To enter your **List Recipes** property values, you must use the **Object Wizard** by clicking the **Configure** button.

To learn more about the **Object Wizard**, see the [Business Activity Frameworks](https://docs.uipath.com/integrations/docs/business-activity-framework) page.

* **Active** - If selected, the activity only returns active (running) recipes.
* **AdapterNames** - A comma-separated list of adapter name(s) (applications) that are included in the recipes you want to retrieve. Enter the exact name (case-sensitive) of the action application. For example, if you want to retrieve a list of recipes that include the Google Drive application, enter *"google_drive"*.
  + One way to find the exact name is to use the activity's **Test Search** button (see example below). If the name(s) that you enter are not found, the activity returns the recipes according to your other parameters (i.e., behaves like you did not enter a value for this property).
* **Order** - Sets the ordering method. There are two options: Activity, Default.
* **SearchAll** - Indicates how the list of names entered in the **AdapterNames** property is applied to the search. If *Selected*, the activity only returns the recipes that include **all**of the adapters listed in the **AdapterNames** property. If *Not Selected*, the activity returns the recipes that include**at least one** of the adapters listed in the **AdapterNames** property.
* **SinceId** - Specifies the highest recipe ID value that you want to retrieve. Enter an `Int32` variable or `Int32` value. The activity returns the recipes with an ID that is less than the value specified in this property.
  :::note
  If you put values in the Sample Value column of the **Object Wizard** you can use the *Test* button to see how those filters affect the results during design time.
  :::

## Properties

### Common

* **DisplayName** - The display name of the activity. This field supports only `Strings` or `String` variables.

### Misc

* **Private** - If selected, the values of variables and arguments are no longer logged at Verbose level.

### Output

* **Recipes** - The list of recipes that match the parameters entered in the input properties. Enter a `Recipe[]` variable. The variable you create for this property can be used as an input variable in subsequent activities (e.g., [Start Recipe](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-start-recipe), [Stop Recipe](https://docs.uipath.com/activities/other/latest/legacy-integrations/workato-stop-recipe)).
  + When using this variable as an input property value, specify the item in the array that you want to use (e.g., *Recipes(0).Id*).
  + The `Recipe` object includes multiple properties that you can use in other activities. You can see a list of these properties in the Workato API [response](https://docs.workato.com/workato-api/recipes.html#response) example.
* **ResponseStatus** - The status of the request (success/failure information). Enter a `ResponseStatus` variable (*UiPath.BAF.Models.ResponseStatus*). The `ResponseStatus` object includes three properties that you can use in other activities.
  + **Success** - `Boolean` - Specifies whether the API request was successful.
  + **ErrorCode** - `String` - The response error if the API request is unsuccessful (**Success**=*False*).
  + **Message** - `String` - The error message.