Skip to main content
GET
/
v2.0
/
flows
/
{flowId}
/
chart
/
nodes
/
{nodeId}
Get the data of the specified ChartNode
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/nodes/{nodeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "type": "if",
  "extension": "@cognigy/basic-nodes",
  "label": "A new Node",
  "comment": "this is a very important node",
  "commentColor": "#ff8a80",
  "isEntryPoint": false,
  "isDisabled": false,
  "config": {
    "condition": {
      "type": "rule",
      "condition": "",
      "rule": {
        "left": "1",
        "operand": "gt",
        "right": "2"
      }
    }
  },
  "localeReference": "63bd8ebb648e6e739f1bbd82",
  "analyticsLabel": "condition",
  "_id": "<string>",
  "conversionMetadata": {
    "fieldName1": "updated",
    "fieldName2": "removed"
  }
}

Authorizations

X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key
string
query
required

Supply the API Key in the Url-Query

Headers

Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

flowId
string
required

The Id of the Flow

Required string length: 24
nodeId
string
required

The Id of the Node

Required string length: 24

Query Parameters

preferredLocaleId
string
Required string length: 24
includeConversionMetadata
boolean

Whether to include conversion metadata in the response. False by default. WIll be available in future releases.

Response

Returns data of the ChartNode

type
string

Type of the Node

Example:

"if"

extension
enum<string>
Available options:
@cognigy/basic-nodes,
@cognigy/mongodb,
@cognigy/mssql,
@cognigy/smtp,
@cognigy/voicegateway,
@cognigy/microsoft,
@cognigy/voiceGateway2
Example:

"@cognigy/basic-nodes"

label
string

Replaces the default name of the Node displayed in the Flow Editor.

Example:

"A new Node"

comment
string

Adds additional information about Nodes, for example, a specific of the Node.

Example:

"this is a very important node"

commentColor
Example:

"#ff8a80"

isEntryPoint
boolean
Example:

false

isDisabled
boolean
Example:

false

config
object
Example:
{
"condition": {
"type": "rule",
"condition": "",
"rule": {
"left": "1",
"operand": "gt",
"right": "2"
}
}
}
localeReference
string
Example:

"63bd8ebb648e6e739f1bbd82"

analyticsLabel
string
Example:

"condition"

_id
string
Required string length: 24
conversionMetadata
object

Optional conversion metadata included when includeConversionMetadata=true

Example:
{
"fieldName1": "updated",
"fieldName2": "removed"
}