Skip to main content
GET
Get flow details

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

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

id
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
health_status
object

Health status of flow and related entities