Skip to main content
GET
/
v1
/
public
/
flows
cURL
curl --request GET \
  --url https://api.frigade.com/v1/public/flows \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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\" />"
    }
  ],
  "offset": 0,
  "limit": 100
}

Authorizations

​
Authorization
string
header
required

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

Return all flows.

​
data
object[]

The data returned by the query

​
offset
number
default:0

The current pagination offset (if any)

Example:

0

​
limit
number
default:100

The total number of records returned in this response

Example:

100