Pisano External API - Nodes - List Nodes
Lists Nodes
Lists Nodes
GET
/external/v1/nodes
Authentication
Authentication Method
Token token=<TOKEN>
Request
Headers
| Header | Required | Description | Example |
|---|---|---|---|
Accept |
No | Specifies the expected response media type. | application/json |
Authorization |
Yes | Pisano API token used to authenticate the request. | Token token=<TOKEN> |
Success Response
200
successful operation
Response Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
string | Unique identifier of the node. | <node_id> |
|
type |
string | Node type/channel type. | Link |
|
name |
string | Node name. | <node_name> |
|
code |
string | Node code. | <node_code> |
|
status |
string | Current status of the node. | active |
|
flow_id |
string | ID of the associated flow. | <flow_id> |
|
flow_code |
string | Code of the associated flow. | <flow_code> |
|
flow_name |
string | Name of the associated flow. | <flow_name> |
|
campaign_id |
string / nullable | Campaign identifier when applicable. | <campaign_id> |
|
access_key |
string / nullable | Access key associated with the node when applicable. | <access_key> |
|
app_id |
string / nullable | Application identifier associated with the node when applicable. | <app_id> |
|
parent_id |
string / nullable | Identifier of the parent node when applicable. | <parent_id> |
|
external_id |
string / nullable | External identifier associated with the node when applicable. | <external_id> |
Response Example
JSON
Response Example
[
{
"id": "<node_id>",
"type": "Link",
"name": "<node_name>",
"code": "<node_code>",
"status": "active",
"flow_id": "<flow_id>",
"flow_code": "<flow_code>",
"flow_name": "<flow_name>",
"campaign_id": "<campaign_id>",
"access_key": "<access_key>",
"app_id": "<app_id>",
"parent_id": "<parent_id>",
"external_id": "<external_id>"
}
]Error Responses
401
Error: Unauthorized
Wrong authentication token
- Error Code
13001- Error Message
- Wrong authentication token
{
"error_message": "Wrong authentication token",
"data": "Wrong authentication token",
"code": 13001,
"errors": null
}
default
error payload
- Error Message
- Error Message
{
"request_id": "<request_id>",
"error_message": "Error Message"
}