Get a workflow

GET /v1/workflows/{workflowId}

Get a workflow

cURL

curl --request GET \
  --url https://app.enzo.health/api/v1/workflows/{workflowId} \
  --header 'Authorization: Bearer <token>'

200

{
  "workflow": {
    "version": "1",
    "groups": [
      {
        "id": "<string>",
        "title": "<string>",
        "graphCoordinates": {
          "x": 123,
          "y": 123
        },
        "blocks": [
          {
            "id": "<string>",
            "type": "text input",
            "outgoingEdgeId": "<string>",
            "options": {
              "labels": {
                "placeholder": "<string>",
                "button": "<string>"
              },
              "variableId": "<string>",
              "isLong": true
            }
          }
        ]
      }
    ],
    "events": [
      {
        "id": "<string>",
        "graphCoordinates": {
          "x": 123,
          "y": 123
        },
        "type": "start",
        "outgoingEdgeId": "<string>"
      }
    ],
    "id": "<string>",
    "name": "<string>",
    "icon": "<string>",
    "edges": [
      {
        "id": "<string>",
        "from": {
          "blockId": "<string>",
          "itemId": "<string>"
        },
        "to": {
          "groupId": "<string>",
          "blockId": "<string>"
        }
      }
    ],
    "variables": [
      {
        "id": "<string>",
        "name": "<string>",
        "groupId": "<string>",
        "isSessionVariable": true,
        "value": "<string>"
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "folderId": "<string>",
    "publicId": "<string>",
    "organizationId": "<string>",
    "resultsTablePreferences": {
      "columnsOrder": [
        "<string>"
      ],
      "columnsVisibility": {},
      "columnsWidth": {}
    },
    "isArchived": true,
    "isClosed": true
  },
  "currentUserMode": "guest"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

workflowId · string · required

Where to find my workflow's ID?

Query Parameters

migrateToLatestVersion · boolean · default: false

If enabled, the workflow will be converted to the latest schema version

Response

200

application/json

Successful response

workflow · object · required

Show child attributes

workflow. version · string · default: 1 · required

workflow. groups · object[] · required

Show child attributes

workflow.groups. id · string · required

workflow.groups. title · string · required

workflow.groups. graphCoordinates · object · required

Show child attributes

workflow.groups.graphCoordinates. x · number · required

workflow.groups.graphCoordinates. y · number · required

workflow.groups. blocks · Text · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object · Block · object[] · required

Text

Block

Block

Block

Block

Block

Block

Block

Block

Block

Block

Block

Block

Block

Block

Show child attributes

workflow.groups.blocks. id · string · required

workflow.groups.blocks. type · enum<string> · required

Available options: text input

workflow.groups.blocks. outgoingEdgeId · string

workflow.groups.blocks. options · object

Show child attributes

workflow.groups.blocks.options. labels · object

Show child attributes

workflow.groups.blocks.options.labels. placeholder · string

workflow.groups.blocks.options.labels. button · string

workflow.groups.blocks.options. variableId · string

workflow.groups.blocks.options. isLong · boolean

workflow. events · object[] · required

Required array length: 1 element

Show child attributes

workflow.events. id · string · required

workflow.events. graphCoordinates · object · required

Show child attributes

workflow.events.graphCoordinates. x · number · required

workflow.events.graphCoordinates. y · number · required

workflow.events. type · enum<string> · required

Available options: start

workflow.events. outgoingEdgeId · string

workflow. id · string · required

workflow. name · string · required

workflow. icon · string | null · required

workflow. edges · object[] · required

Show child attributes

workflow.edges. id · string · required

workflow.edges. from · object · required

Option 1

Option 2

Show child attributes

workflow.edges.from. blockId · string · required

workflow.edges.from. itemId · string

workflow.edges. to · object · required

Show child attributes

workflow.edges.to. groupId · string · required

workflow.edges.to. blockId · string

workflow. variables · object[] · required

Show child attributes

workflow.variables. id · string · required

workflow.variables. name · string · required

workflow.variables. groupId · string

workflow.variables. isSessionVariable · boolean

workflow.variables. value

workflow. createdAt · string · required

workflow. updatedAt · string · required

workflow. folderId · string | null · required

workflow. publicId · string | null · required

workflow. organizationId · string · required

workflow. resultsTablePreferences · object · required

Show child attributes

workflow.resultsTablePreferences. columnsOrder · string[] · required

workflow.resultsTablePreferences. columnsVisibility · object · required

Show child attributes

workflow.resultsTablePreferences.columnsVisibility. {key} · boolean

workflow.resultsTablePreferences. columnsWidth · object · required

Show child attributes

workflow.resultsTablePreferences.columnsWidth. {key} · number

workflow. isArchived · boolean · required

workflow. isClosed · boolean · required

currentUserMode · enum<string> · required

Available options: guest, read, write