Developer APIResourcesRecipes

Get a recipe

Returns details about a recipe object. Lifetime task count has task data starting from March 19, 2021.

Path parameters

recipe_idintegerRequired
Recipe ID.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

version_nointegerOptional
Version number.
cloned_recipe_id"true"OptionalDefaults to true

Set to true to include cloned recipe details in the response.

Response

Recipe details
idinteger
Recipe ID.
user_idinteger
User ID.
namestring
Recipe title.
created_atstring
Timestamp in ISO 8601 format.
updated_atstring
Timestamp in ISO 8601 format.
copy_countinteger
Number of times the recipe has been copied.
trigger_applicationstring
Application used in the trigger.
action_applicationslist of strings
List of applications used in the recipe actions.
applicationslist of strings
List of applications used in the recipe.
descriptionstring
Description of the recipe.
parameters_schemalist of strings
List of parameter schema definitions.
parametersmap from strings to any
Parameters Hash.
webhook_urlstring
Webhook URL in case of real time triggers.
folder_idinteger
Folder for the recipe.
runningboolean
Running status of the recipe.
job_succeeded_countinteger
Count of successful jobs.
job_failed_countinteger
Count of failed jobs.
lifetime_task_countinteger
Lifetime task count of the recipe starting from March 19, 2021.
last_run_atstring
Timestamp in ISO 8601 format.
stopped_atstring
Timestamp in ISO 8601 format.
version_nointeger
Version number of the recipe.
version_author_namestring
Name of the user who created this version of the recipe.
version_author_emailstring
Email of the user who created this version of the recipe.
version_commentstring
Comment associated with this version.
stop_causestring
Stop reason.
configlist of strings
Array of Hash representing the connection lines.
trigger_closuremap from strings to any
Trigger closure of the recipe. Contains information about the last poll and are used to make the subsequent polls.
codestring
JSON string representing the recipe lines.
cloned_recipe_idinteger
ID of the cloned recipe.
cloned_recipemap from strings to any
Hash containing details of the cloned recipe. Contains response structure similar to this recipe.
author_namestring
Name of the user who created this recipe.

Errors