Get flow details

GET

{flow_id}

Get flow details

curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id} \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}', 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://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}",
  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://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}")

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

{
  "id": "flow-1",
  "name": "appointment_booking",
  "status": "DRAFT",
  "categories": [
    "APPOINTMENT_BOOKING"
  ],
  "validation_errors": [],
  "json_version": "3.0",
  "data_api_version": "3.0",
  "endpoint_uri": "https://example.com"
}

{
  "error": {
    "message": "Invalid phone number format",
    "type": "OAuthException",
    "code": 400,
    "error_subcode": 1001,
    "fbtrace_id": "AXk7s_8dR4eVHp9Kq2MmNlO"
  }
}

Authorizations

X-API-Key

string

header

required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Integrations > API keys.

Path Parameters

flow_id

string

required

Flow ID

Query Parameters

fields

string

required

Comma-separated list of fields to retrieve.

Available fields: id, name, status, categories, validation_errors, json_version, data_api_version, endpoint_uri, preview, whatsapp_business_account, application, health_status

Preview can be invalidated: preview.invalidate(true)

Metrics: metric.name(ENDPOINT_REQUEST_COUNT).granularity(DAY).since(2024-01-28).until(2024-01-30)

phone_number_id

string

Required when accessing flow by ID (unless business_account_id provided)

business_account_id

string

Required when accessing flow by ID (unless phone_number_id provided)

Response

Flow details retrieved successfully

string

name

string

status

enum<string>

Available options:

DRAFT,

PUBLISHED,

DEPRECATED,

BLOCKED,

THROTTLED

categories

string[]

validation_errors

object[]

json_version

string

data_api_version

string

endpoint_uri

string<uri>

preview

object

Show child attributes

health_status

object

Health status of flow and related entities

Get flow details

curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id} \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}', 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://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}",
  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://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}")

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

{
  "id": "flow-1",
  "name": "appointment_booking",
  "status": "DRAFT",
  "categories": [
    "APPOINTMENT_BOOKING"
  ],
  "validation_errors": [],
  "json_version": "3.0",
  "data_api_version": "3.0",
  "endpoint_uri": "https://example.com"
}

{
  "error": {
    "message": "Invalid phone number format",
    "type": "OAuthException",
    "code": 400,
    "error_subcode": 1001,
    "fbtrace_id": "AXk7s_8dR4eVHp9Kq2MmNlO"
  }
}

Overview

WhatsApp API

Platform API

Workflows API

Kapso Agent API

Authorizations

Path Parameters

Query Parameters

Response