Skip to main content
GET
/
v2.0
/
flows
/
{flowId}
/
chart
/
nodes
/
{nodeId}
Get a Node
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/nodes/{nodeId} \
  --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",
  "mock": {
    "isEnabled": false,
    "code": "console.log('Hello, world!');"
  },
  "_id": "<string>",
  "conversionMetadata": {
    "fieldName1": "updated",
    "fieldName2": "removed"
  }
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

​
Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

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

Path Parameters

​
flowId
string
required

The unique identifier for the Flow.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
nodeId
string
required

The Id of the Node

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Query Parameters

​
preferredLocaleId
string

The unique identifier for the Locale for the response.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
includeConversionMetadata
boolean

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

Response

Returns the Node configuartion successfully.

​
type
string

Type of the Node

Example:

"if"

​
extension
string
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
Pattern: ^#(?:[0-9a-fA-F]{3}){1,2}$
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"

​
mock
object
​
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
conversionMetadata
object

Optional conversion metadata included when includeConversionMetadata=true

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