List workflows for the caller workspace

GET /workflows

List workflows for the caller workspace

cURL

curl --request GET \
  --url https://api.pineyard.ai/workflows \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "status": "DRAFT",
    "definition": {
      "definitionVersion": 1,
      "nodes": [
        {
          "id": "start",
          "type": "start",
          "position": {
            "x": 0,
            "y": 0
          },
          "data": {}
        },
        {
          "id": "end_ok",
          "type": "end",
          "position": {
            "x": 0,
            "y": 1
          },
          "data": {
            "label": "Done"
          }
        }
      ],
      "edges": [
        {
          "id": "e1",
          "source": "start",
          "target": "end_ok"
        }
      ]
    },
    "definitionVersion": 123,
    "callingTimezone": "<string>",
    "dailyWindowStart": "<string>",
    "dailyWindowEnd": "<string>",
    "dialDays": [
      123
    ],
    "dailyOutreachCap": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
]

Required scope: workflows.view

Requires workflows enabled for your workspace. Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Response

200

application/json

OK

id · string · required

name · string · required

status · enum<string> · required

Available options: DRAFT, ACTIVE, ARCHIVED

definition · object · required

Opaque workflow definition JSON object. Graph validation is performed by the workflow validator.

Show child attributes

Example:

{
  "definitionVersion": 1,
  "nodes": [
    {
      "id": "start",
      "type": "start",
      "position": { "x": 0, "y": 0 },
      "data": {}
    },
    {
      "id": "end_ok",
      "type": "end",
      "position": { "x": 0, "y": 1 },
      "data": { "label": "Done" }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "start",
      "target": "end_ok"
    }
  ]
}

definitionVersion · number · required

callingTimezone · string | null · required

dailyWindowStart · string | null · required

dailyWindowEnd · string | null · required

dialDays · integer[] · required

dailyOutreachCap · integer | null · required

createdAt · string · required

updatedAt · string · required