Workflows

Get Workflow

Retrieve the details of a specific workflow.

Note: Workflow APIs are available on cloud-hosted Business plans and above, and on licensed self-hosted deployments (Business plan and above).

get/api/v3/meta/bases/{baseId}/workflows/{workflowId}

Request

Path parameters

baseIdstring required

Unique identifier for the base.

workflowIdstring required

Unique identifier for the workflow.

Response

Workflow retrieved.

idstring required

Unique identifier for the workflow

titlestring required

Title of the workflow

descriptionstring nullable

Description of the workflow

base_idstring required

Unique identifier for the base

workspace_idstring required

Unique identifier for the workspace

enabledboolean

Whether the workflow is enabled

created_atstring date-time required

Timestamp when the workflow was created

updated_atstring date-time required

Timestamp when the workflow was last updated

created_bystring

User ID of the creator

updated_bystring

User ID of the last updater

Example response

{
  "nodes": [
    {
      "type": "nocodb.trigger.after_insert"
    }
  ],
  "draft": {
    "nodes": [
      {
        "type": "nocodb.trigger.after_insert"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.