Skip to content
English
Submit A Ticket Customer Portal
LOGIN
  • There are no suggestions because the search field is empty.

Pisano External API - Flows - Show Flow Details

Shows Flow Details

Shows Flow Details

GET /external/v1/flows/{flowId}

Authentication

Authentication Method Token token=<TOKEN>

Request

Path Parameters

Parameter Type Required Description Example
flowId string Yes ID of Flow to return flowId

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

Response Fields

Field Type Required Description Example
id string Unique identifier of the flow. b1917993-0fea-4b23-8442-a64430ae38a9
name string Name of the flow. Test Flow
key Flow key. Can be null. null
questions array Questions defined in the flow.
questions[].id string Unique identifier of the question. 271b4039-f3a3-4f61-b7a0-8d5b6abe522e
questions[].key string / nullable Question key. Can be null. question_1
questions[].body.<language_code> string Question text for the specified language. How are you?
questions[].style string Question type/style. checklist
questions[].options array Available options for the question. Can be empty.
questions[].options[].id string Unique identifier of the option. 271b4039-f3a3-4f61-b7a0-8d5b6abe522e
questions[].options[].key string Option key. option_1
questions[].options[].body.<language_code> string Option text for the specified language. Good

Response Example

JSON Response Example 
{
  "id": "<flow_id>",
  "name": "<flow_name>",
  "key": null,
  "questions": [
    {
      "id": "<question_id>",
      "key": "<question_key>",
      "body": {
        "TR": "<question_text>"
      },
      "style": "score",
      "options": [
        {
          "id": "<option_id>",
          "key": "10",
          "body": {
            "TR": "10"
          }
        }
      ]
    }
  ]
}

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"}}