WorkflowOverview

Operational info for a workflow: metadata (same fields as List Workflows), sheet roster with settings and webhook URLs, and shared users.

Properties

workflow_idstring <uuid>required

UUID of the parent workflow.

namestringrequired

Workflow name as set at creation.

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 across every sheet in this workflow. `null` if no sheet has ever been run.

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.

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`.

is_ownerbooleanrequired

`true` when the caller is the workflow owner.

shared_usersarray ofrequired

Emails the workflow is shared with (edit access). Populated for the owner and org admins; otherwise `[]`.

string <email>

sheetsarray ofrequired

Every sheet in the workflow with its settings and webhook URL. `sheets[0]` is the main sheet.

WorkflowOverviewSheet

Example

WorkflowOverview example

{
  "workflow_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "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,
  "is_owner": false,
  "shared_users": [
    "user@example.com"
  ],
  "sheets": [
    {
      "sheet_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "is_main_sheet": false,
      "auto_run": false,
      "cache_enabled": false,
      "cache_since": null,
      "continue_on_fail": false,
      "webhook_url": null
    }
  ]
}