Lodol Docs

Workflows

API endpoints for listing and inspecting workflows.

Workflows

Workflows are the core resource in Lodol. They define a series of automated steps represented as a program AST (Abstract Syntax Tree).

The Workflow Object

{
  "id": "665f1a2b3c4d5e6f7a8b9c0d",
  "name": "Welcome Email Workflow",
  "description": "Sends a welcome email when a user signs up",
  "created_by": "665f1a2b3c4d5e6f7a8b9c0e",
  "created_at": "2026-01-15T10:30:00+00:00",
  "updated_at": "2026-01-15T10:30:00+00:00",
  "last_run_at": "2026-03-17T08:00:00+00:00"
}
FieldTypeDescription
idstringUnique identifier (MongoDB ObjectId)
namestringName of the workflow
descriptionstringDescription of the workflow
created_bystring | nullID of the user who created the workflow
created_atstring | nullISO 8601 timestamp of creation
updated_atstring | nullISO 8601 timestamp of last update
last_run_atstring | nullISO 8601 timestamp of the most recent execution

List Workflows

GET /api/v1/workflows

Returns all workflows belonging to the workspace associated with the API key. The workspace is derived from the API key — no team_id parameter is needed.

Required scope: workflows:read

Example

curl https://app.skipflow.com/api/v1/workflows \
  -H "Authorization: Bearer sk_live_your_api_key"

Response (200)

{
  "workflows": [
    {
      "id": "665f1a2b3c4d5e6f7a8b9c0d",
      "name": "Welcome Email Workflow",
      "description": "Sends a welcome email when a user signs up",
      "created_by": "665f1a2b3c4d5e6f7a8b9c0e",
      "created_at": "2026-01-15T10:30:00+00:00",
      "updated_at": "2026-01-15T10:30:00+00:00",
      "last_run_at": "2026-03-17T08:00:00+00:00"
    }
  ]
}

Get a Workflow

GET /api/v1/workflows/:id

Retrieves a workflow by its ID, including the full program AST.

Required scope: workflows:read

Example

curl https://app.skipflow.com/api/v1/workflows/665f1a2b3c4d5e6f7a8b9c0d \
  -H "Authorization: Bearer sk_live_your_api_key"

Response (200)

{
  "id": "665f1a2b3c4d5e6f7a8b9c0d",
  "name": "Welcome Email Workflow",
  "description": "Sends a welcome email when a user signs up",
  "program": {
    "kind": "Program",
    "version": 1,
    "body": [...]
  },
  "created_by": "665f1a2b3c4d5e6f7a8b9c0e",
  "created_at": "2026-01-15T10:30:00+00:00",
  "updated_at": "2026-01-15T10:30:00+00:00",
  "last_run_at": "2026-03-17T08:00:00+00:00"
}

The program field contains the full workflow AST. See the Core section for details on expressions and statements.

On this page