flows

List flows

Flows in the workspace, newest first. Archived flows are excluded unless archived=true.

get/v1/flows

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/flows
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token, scopes: flows:read)

Query parameters

archivedboolean

Return archived flows instead of live ones.

qstring

Match on flow name.

sizeinteger

Page size, 1–100.

frominteger

Offset.

Response

SUCCESS

totalinteger required

Total matching, not the length of items.

Example response

{
  "items": [
    {
      "id": "flw_2b8e10",
      "publicUrl": "https://platform.flowral.app/public/flow/flw_2b8e10"
    }
  ]
}

Changes

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