flows

GET /v1/public/flows

Get all Flows for your organization.

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Response

Return all flows.

offsetnumber

The current pagination offset (if any)

limitnumber

The total number of records returned in this response

Example response

{
  "data": [
    {
      "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\" />"
    }
  ],
  "limit": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.