Pisano External API - Flows - Show Flow Details
Shows Flow Details
Shows Flow Details
GET
/external/v1/flows/{flowId} Request
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
flowId |
string | Yes | ID of Flow to return | flowId |
Headers
| Header | Required | Description | Example |
|---|---|---|---|
Accept |
application/json |
Success Response
200
successful
Response Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
b1917993-0fea-4b23-8442-a64430ae38a9 |
|||
name |
Test Flow | |||
questions[].id |
271b4039-f3a3-4f61-b7a0-8d5b6abe522e |
|||
questions[].key |
question_1 |
|||
questions[].body.EN |
How are you? | |||
questions[].style |
checklist | |||
questions[].options[].id |
271b4039-f3a3-4f61-b7a0-8d5b6abe522e |
|||
questions[].options[].key |
option_1 |
|||
questions[].options[].body.EN |
Good | |||
questions[].options[].body.TR |
Ä°yi |
Response Example
JSON
Response Example
{
"id": "b1917993-0fea-4b23-8442-a64430ae38a9",
"name": "Test Flow",
"questions": [
{
"id": "271b4039-f3a3-4f61-b7a0-8d5b6abe522e",
"key": "question_1",
"body": {
"EN": "How are you?"
},
"style": "checklist",
"options": [
{
"id": "271b4039-f3a3-4f61-b7a0-8d5b6abe522e",
"key": "option_1",
"body": {
"EN": "Good",
"TR": "Ä°yi"
}
}
]
}
]
}Error Responses
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":{"flow_id":"b1917993-0fea-4b23-8442-a64430ae38a9"}}