Workflow

A workflow summary. Timestamps are ISO 8601 UTC; `last_run_at` is `null` until the workflow is first run.

Properties

workflow_idstring <uuid>required

UUID of the workflow. Use this with every endpoint that takes `{workflow_id}`.

namestringrequired

Workflow name as set at creation.

owner_emailstring <email>required

Email of the member who owns the workflow.

created_atstring <date-time>required

UTC timestamp (ISO 8601) when the workflow was created.

updated_atstring <date-time>required

UTC timestamp (ISO 8601) of the most recent configuration change (name, inputs, actions, sheet settings).

last_run_atnull | string <date-time>required

UTC timestamp (ISO 8601) of the most recent run on any sheet in this workflow. `null` if it has never been run. Runs started outside this API — on a schedule, or by a webhook trigger — do not update it.

folder_idnull | stringrequired

ID of the folder holding the workflow in the API key holder's workflow list. `null` when it sits at the top level, or when it is another member's workflow listed with `scope=org`.

folder_pathnull | arrayrequired

Folder names from the top-level folder down to the one holding the workflow, e.g. `["Reporting", "Weekly"]`. `null` when `folder_id` is `null`.

Example

Workflow example
{
  "workflow_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "owner_email": "user@example.com",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "last_run_at": null,
  "folder_id": null,
  "folder_path": null
}