Get Workflows

1 curl https://api.skyvern.com/v1/workflows \ 2 -H "x-api-key: <x-api-key>"

1 [ 2 { 3 "workflow_id": "foo", 4 "organization_id": "foo", 5 "title": "foo", 6 "workflow_permanent_id": "foo", 7 "version": 42, 8 "is_saved_task": true, 9 "workflow_definition": { 10 "parameters": [ 11 { 12 "parameter_type": "workflow", 13 "key": "foo", 14 "description": "foo", 15 "workflow_parameter_id": "foo", 16 "workflow_parameter_type": "string", 17 "workflow_id": "foo", 18 "default_value": {}, 19 "created_at": "foo", 20 "modified_at": "foo", 21 "deleted_at": "foo" 22 } 23 ], 24 "blocks": [ 25 { 26 "label": "foo", 27 "block_type": "for_loop", 28 "output_parameter": { 29 "parameter_type": "output", 30 "key": "foo", 31 "description": "foo", 32 "output_parameter_id": "foo", 33 "workflow_id": "foo", 34 "created_at": "foo", 35 "modified_at": "foo", 36 "deleted_at": "foo" 37 }, 38 "continue_on_failure": false, 39 "model": {}, 40 "loop_blocks": [ 41 { 42 "label": "foo", 43 "block_type": "for_loop", 44 "output_parameter": { 45 "parameter_type": "output", 46 "key": "foo", 47 "description": "foo", 48 "output_parameter_id": "foo", 49 "workflow_id": "foo", 50 "created_at": "foo", 51 "modified_at": "foo", 52 "deleted_at": "foo" 53 }, 54 "continue_on_failure": false, 55 "model": {}, 56 "loop_blocks": [ 57 { 58 "label": "foo", 59 "block_type": "for_loop", 60 "output_parameter": {}, 61 "continue_on_failure": false, 62 "loop_blocks": [ 63 null 64 ], 65 "complete_if_empty": false 66 } 67 ], 68 "loop_over": { 69 "parameter_type": "workflow", 70 "key": "foo", 71 "workflow_parameter_id": "foo", 72 "workflow_parameter_type": "string", 73 "workflow_id": "foo", 74 "created_at": "foo", 75 "modified_at": "foo" 76 }, 77 "loop_variable_reference": "foo", 78 "complete_if_empty": false 79 } 80 ], 81 "loop_over": { 82 "parameter_type": "workflow", 83 "key": "foo", 84 "description": "foo", 85 "workflow_parameter_id": "foo", 86 "workflow_parameter_type": "string", 87 "workflow_id": "foo", 88 "default_value": {}, 89 "created_at": "foo", 90 "modified_at": "foo", 91 "deleted_at": "foo" 92 }, 93 "loop_variable_reference": "foo", 94 "complete_if_empty": false 95 } 96 ] 97 }, 98 "created_at": "foo", 99 "modified_at": "foo", 100 "description": "foo", 101 "proxy_location": "RESIDENTIAL", 102 "webhook_callback_url": "foo", 103 "totp_verification_url": "foo", 104 "totp_identifier": "foo", 105 "persist_browser_session": false, 106 "model": {}, 107 "status": "published", 108 "deleted_at": "foo" 109 } 110 ]

Get all workflows with the latest version for the organization.

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional>=1Defaults to 10

only_saved_tasksbooleanOptionalDefaults to false

only_workflowsbooleanOptionalDefaults to false

titlestringOptionalDefaults to

templatebooleanOptionalDefaults to false

Response

Successful Response

workflow_idstring

organization_idstring

titlestring

workflow_permanent_idstring

versioninteger

is_saved_taskboolean

workflow_definitionobject

created_atstringformat: "date-time"

modified_atstringformat: "date-time"

descriptionstring or null

proxy_locationenum or null

webhook_callback_urlstring or null

totp_verification_urlstring or null

totp_identifierstring or null

persist_browser_sessionboolean or nullDefaults to false

modelmap from strings to any or null

statusenum or null

Allowed values:

deleted_atstring or nullformat: "date-time"

Headers

Query parameters

Response

Errors