GET
/
v1
/
flows
curl --request GET \
  --url https://cloud.activepieces.com/api/v1/flows \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "created": "<string>",
      "updated": "<string>",
      "projectId": "<string>",
      "externalId": "<string>",
      "folderId": "<string>",
      "status": "ENABLED",
      "schedule": {
        "type": "CRON_EXPRESSION",
        "cronExpression": "<string>",
        "timezone": "<string>",
        "failureCount": 123
      },
      "handshakeConfiguration": {
        "strategy": "NONE",
        "paramName": "<string>"
      },
      "publishedVersionId": "<string>",
      "metadata": {},
      "version": {
        "id": "<string>",
        "created": "<string>",
        "updated": "<string>",
        "flowId": "<string>",
        "displayName": "<string>",
        "trigger": {
          "name": "<string>",
          "valid": true,
          "displayName": "<string>",
          "nextAction": "<any>",
          "type": "PIECE_TRIGGER",
          "settings": {
            "pieceName": "<string>",
            "pieceVersion": "<string>",
            "pieceType": "CUSTOM",
            "packageType": "ARCHIVE",
            "triggerName": "<string>",
            "input": {},
            "inputUiInfo": {
              "sampleDataFileId": "<string>",
              "sampleDataInputFileId": "<string>",
              "lastTestDate": "<string>",
              "customizedInputs": {},
              "schema": {},
              "currentSelectedData": "<any>"
            }
          }
        },
        "updatedBy": "<string>",
        "valid": true,
        "schemaVersion": "<string>",
        "state": "LOCKED",
        "connectionIds": [
          "<string>"
        ]
      }
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Query Parameters

folderId
string
limit
number
cursor
string
status
enum<string>[]
projectId
string
required
name
string
versionState
Available options:
LOCKED
connectionExternalIds
string[]

Response

200 - application/json

Default Response

The response is of type object.