Workflows

Inspect a Workflow

Changed on

Returns the Workflow's library entry (caller role, connection readiness, result freshness, view state, Automation count), its detail (current and past versions, latest snapshot, latest successful snapshot), and the generated Artifact views bound to it. maxAgeMs (60 seconds to 30 days, default 24 hours) is the threshold that classifies the latest result as fresh or stale. Version code and example input are redacted for members without manager access; when generated Artifact views are disabled for the deployment, views is empty and viewState is default.

get/v1/workflows/{configObjectId}

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/workflows/{configObjectId}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

configObjectIdstring required

Query parameters

maxAgeMsinteger

Response

Workflow returned.

Changes

  • c414a8a96254Revision changes
    • info

      added the optional property // to the response with the status

  • bb8ff73e4ad3Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API