Retrieve a single workflow

GET 
/workflows/:workflowId

Find a workflow given a workflowId

Request

Path Parameters

workflowId stringrequired

The Id of the workflow to find

Query Parameters

userId stringrequired

The Id of the user you want to lookup. Returned from the Create User endpoint. Note: you can also use the Embedded user's username in this field.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

data

object

workflowId string

integrationId string

name string

createdAt string

updatedAt string

installed boolean

Default value: true

active boolean

Default value: true

version integer

Default value: 0

installedVersion integer

Default value: 0

blocks

object[]

Array [

name string

id string

type string

icon string

]

Example (from schema)

{
  "data": {
    "workflowId": "61af97f3a64b5900144610d8",
    "integrationId": "632ca935bb5c785d64d095b5",
    "name": "New Customer Created",
    "createdAt": "2021-12-07T17:20:51.889Z",
    "updatedAt": "2021-12-07T17:36:32.454Z",
    "installed": true,
    "active": true,
    "version": 2,
    "installedVersion": 1,
    "blocks": [
      {
        "name": "Custom Event",
        "id": "acd92ef8-303a-4c31-b323-c55fb2d7a41f",
        "type": "customEvent",
        "icon": "https://cdn.runalloy.com/icons/app-event.svg"
      }
    ]
  }
}

Result

{
  "data":
    {
      "workflowId": "61af97f3a64b5900144610d8",
      "integrationId": "632ca935bb5c785d64d095b5",
      "name": "New Customer Created",
      "createdAt": "2021-12-07T17:20:51.889Z",
      "updatedAt": "2021-12-07T17:36:32.454Z",
      "installed": true,
      "active": true,
      "version": 2,
      "installedVersion": 1,
      "blocks": [
        {
          "name": "Custom Event",
          "id": "acd92ef8-303a-4c31-b323-c55fb2d7a41f",
          "type": "customEvent",
          "icon": "https://cdn.runalloy.com/icons/app-event.svg"
        },
        {
          "name": "Slack",
          "id": "ff827207-a709-4689-a9e4-2e202af3a333",
          "type": "slack",
          "icon": "https://cdn.runalloy.com/icons/slack.png"
        }
      ]
    }
}

Loading...