Get flow with definition

Returns flow details including the complete definition structure

GET /flows/{flow_id}/definition

Get flow with definition

cURL

curl --request GET \
  --url https://app.kapso.ai/api/v1/flows/{flow_id}/definition \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.kapso.ai/api/v1/flows/{flow_id}/definition"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.kapso.ai/api/v1/flows/{flow_id}/definition', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/flows/{flow_id}/definition",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kapso.ai/api/v1/flows/{flow_id}/definition"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.kapso.ai/api/v1/flows/{flow_id}/definition")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/flows/{flow_id}/definition")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "flow-123abc",
    "name": "Customer Onboarding Flow",
    "description": "Automated flow for onboarding new customers",
    "status": "active",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "last_executed_at": "2023-11-07T05:31:56Z",
    "execution_count": 42,
    "definition": {
      "nodes": [
        {
          "id": "start_node_1",
          "type": "flow-node",
          "position": {
            "x": 100,
            "y": 200
          },
          "data": {
            "nodeType": "start",
            "config": {},
            "displayName": "Start"
          }
        }
      ],
      "edges": [
        {
          "id": "edge_1",
          "source": "start_node_1",
          "target": "send_text_1",
          "label": "next",
          "type": "default",
          "flow_condition_id": "<string>"
        }
      ]
    },
    "whatsapp_configs": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Main WhatsApp Config",
        "phone_number": "[phone]"
      }
    ]
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Path Parameters

flow_id · string<uuid> · required

Response

200

application/json

Flow with complete definition

data · object

Show child attributes