List workflows

GET

/api/v1/workflows

const url = 'https://dashboard.justcrawl.io/api/v1/workflows?status=draft';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dashboard.justcrawl.io/api/v1/workflows?status=draft' \
  --header 'Authorization: Bearer <token>'

List all workflows (latest version per logical workflow) for the current organization.

Authorizations

bearerAuth

Parameters

Query Parameters

status

string

Allowed values: draft published

Filter workflows by status.

domain

string

Narrow to workflows routed to this domain (route=“domain:X” or default ”*”); domain-specific routes sorted first.

Responses

200

An array of workflows.

application/json

Array<object>

object

workflowId

string format: uuid

name

string

status

string

Allowed values: draft published

version

integer

route

string

nullable

dag

object

nodes

required

Array<object>

object

required

string

type

required

string

Allowed values: entry service split result failed

config

object

edges

required

Array<object>

object

required

string

from

required

string

required

string

type

required

string

Allowed values: default success fail split

costPerThousand

number

nullable

smart

object

strategy

string

Allowed values: success cost reliability

mode

string

Allowed values: auto suggest

domain

string

nullable

hasPendingSuggestion

boolean

createdAt

string format: date-time

Example

[
  {
    "status": "draft",
    "dag": {
      "nodes": [
        {
          "type": "entry"
        }
      ],
      "edges": [
        {
          "type": "default"
        }
      ]
    },
    "smart": {
      "strategy": "success",
      "mode": "auto"
    }
  }
]