GET
/
v1
/
public
/
flows
/
{slug}

Authorizations

​
Authorization
string
headerrequired

Authentication header of the form Bearer: <token>, where <token> is either your public or private API key. See when to use which

Response

200 - application/json
​
id
number

The numeric ID of the Flow. This number will be different depending on the version used

​
name
string

The name of the Flow

​
data
string

JSON encoded raw data of the Flow as defined in the Flow's YAML configuration

​
targetingLogic
string

The targeting logic for the Flow

​
type
enum<string>

The type of Flow

Available options:
ANNOUNCEMENT,
BANNER,
CARD,
CHECKLIST,
CUSTOM,
FORM,
SURVEY,
TOUR
​
slug
string

A unique identifier for the Flow such as flow_abc. Slugs stay the same between environment and versions.

​
createdAt
string

The data the Flow was created in ISO 8601 format

​
modifiedAt
string

The data the Flow was last modified in ISO 8601 format

​
version
number

The version of the Flow

​
status
enum<string>

The status of the Flow

Available options:
ACTIVE,
ARCHIVED,
DRAFT
​
codeSnippet
string

The original code snippet for the Flow when it was created

Get all FlowsUpdate Flow