Pisano External API - Flows - List Flows
Lists Flows
Lists Flows
GET
/external/v1/flows
Authentication
Authentication Method
Token token=<TOKEN>
Request
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
node_id |
string | Yes | Node ID | node_id |
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> |
Responses
200
successful operation
Response Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
string | Unique identifier of the flow. | <flow_id> |
|
name |
string | Name of the flow. | <flow_name> |
|
key |
Flow key. Can be null. | null |
||
allow_saving_incomplete_survey |
boolean | Indicates whether incomplete survey responses can be saved. | false |
Response Example
JSON
Response Example
[
{
"id": "<flow_id>",
"name": "<flow_name>",
"key": null,
"allow_saving_incomplete_survey": false
}
]
401
Error: Unauthorized
Error: Unauthorized
- Error Code
13001- Error Message
- Wrong authentication token
{"error_message":"Wrong authentication token","data":"Wrong authentication token","code":13001,"errors":null}
404
Error: Not Found
Error: Not Found
- Error Code
13002- Error Message
- Requested resource not found!
{
"error_message": "Requested resource not found!",
"data": "Requested resource not found!",
"code": 13002,
"errors": {
"node_id": null
}
}
default
error payload
error payload
- Error Message
- {"request_id":"b1917993-0fea-4b23-8442-a64430ae38a9","error_message":"Error Message"}
{"request_id":"b1917993-0fea-4b23-8442-a64430ae38a9","error_message":"Error Message"}