Get a campaign's workflow

GET

/api/v1/campaigns/{id}/flow

GET

/api/v1/campaigns/{id}/flow

The editable flow spec, whatever form the campaign is stored in (a classic campaign shows as its linear flow).

Authorization

headerAuthorizationBearer <token>

An Enhance API key (rsen_…) or an OAuth 2.1 access token, as "Authorization: Bearer …".

Path Parameters

id*string

Campaign id

Response Body

application/json

response

id*string

hasFlow*boolean

The campaign has a stored workflow

storedAs*string

flow or classic

Value in"flow""classic"

taskCount?integer

spec?

A workflow (GET /api/v1/schema/flow documents nodes, edges and subflows; mode nodes reference tasks[] by index)

flowGraph?

The stored graph (null for a classic campaign)

warning?string

Example Request

curl -X GET 'https://panel.rankshark.io/api/v1/campaigns/string/flow'

Example Request

curl -X GET 'https://panel.rankshark.io/api/v1/campaigns/string/flow'

Example ResponseSchema

{
  "id": "string",
  "hasFlow": true,
  "storedAs": "flow",
  "taskCount": 0,
  "spec": {
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ],
    "subflows": {}
  },
  "flowGraph": {},
  "warning": "string"
}

{  "id": "string",  "hasFlow": true,  "storedAs": "flow",  "taskCount": 0,  "spec": {    "nodes": [      {}    ],    "edges": [      {}    ],    "subflows": {}  },  "flowGraph": {},  "warning": "string"}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body