GET
/
v1
/
public
/
flows
/
{slug}
curl --request GET \
  --url https://api.frigade.com/v1/public/flows/{slug} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "name": "New User Announcement",
  "data": "{\"steps\": [{\"id\": \"step_1\", \"title\": \"Welcome to my app!\", \"subtitle\": \"Let me show you around.\"}]}",
  "targetingLogic": "user.property('isAdmin') == true",
  "type": "CHECKLIST",
  "slug": "flow_abc",
  "createdAt": "2024-01-01T00:00:00Z",
  "modifiedAt": "2024-01-01T00:00:00Z",
  "version": 1,
  "status": "ACTIVE",
  "codeSnippet": "<Frigade.Announcement flowId=\"my-flow-id\" />"
}

Authorizations

Authorization
string
headerrequired

Authentication header of the form Bearer: <token>, where <token> is your public or private Frigade API key

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