v1

latestOpenAPI 3.0.12026-07-265879107.5 KB

Workflows

Get the latest draft playbook version for a playbook

get/workspace/{ws_id}/playbooks/{id}/draft

Path parameters

ws_idstring required

The ID of the workspace containing the playbook

idstring required

The ID of the playbook to retrieve the version of

Response

Latest draft version

activeboolean

Whether the playbook is currently active

analyst_copilot_workflowboolean

Whether this is an Analyst Copilot workflow

automation_origin_idstring

The ID of the original playbook if this is a replica

automation_typestring

The type of automation

branchstring

branched_frominteger

created_atinteger

created_bystring

custom_timeoutinteger

Custom execution timeout in hours

deletedstring

When the playbook was deleted

has_published_versionboolean

iconstring

The icon associated with the playbook

idstring

is_icon_selected_by_userboolean

Whether the icon was manually selected

is_otbboolean

Whether this is an Out-Of-The-Box playbook

is_publishedboolean

is_requestboolean

Whether the playbook is exposed as a self-service request

link_typestring

Playbook version's link type

max_concurrency_levelinteger

Maximum number of concurrent executions (0 for unlimited)

namestring

The name of the playbook

notification_emailsstring

A comma-separated list of emails for notifications

pack_idstring

The ID of the automation pack containing this playbook

playbookstring

The YAML definition of the playbook

playbook_to_run_on_errorstring

The ID of the playbook to run if this one fails

preferred_engine_versionstring

The preferred workflow engine version

runnerstring

The name of the runner group assigned to this playbook

sourcestring

step_transition_limitinteger

Maximum number of step transitions allowed in a single execution

subflows_reference_to_name_mappingobject

Subflow reference IDs to playbook names mapping

tagsstring[]

Tags associated with the playbook

tenant_idstring

The ID of the parent tenant

updated_atinteger

updated_bystring

used_connectionsstring[]

List of connection IDs used by the playbook

used_global_variablesstring[]

List of used global variables

used_subflowsstring[]

List of subflow IDs used by the playbook

used_tablesstring[]

List of used tables

versionstring

The version of the playbook

version_idinteger

wizard_idstring

The ID of the wizard used to create this playbook

workspace_idstring

The ID of the parent workspace

Example response

{
  "display_settings": {
    "description": "Automates common tasks",
    "icon": "company-blink",
    "name": "Blink Automation"
  },
  "icon": "company-blink",
  "name": "My Workflow",
  "pack_id": "00000000-0000-0000-0000-000000000000",
  "tags": [
    "k8s"
  ],
  "version": "1"
}