ghl_workflow_get_definition
Read a workflow's complete definition for inspection or round-trip updates, preserving its version counter to prevent overwriting concurrent builder edits.
Instructions
WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days.
Get Workflow Definition
Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.
Read a workflow as a complete definition. The definition object is accepted verbatim by Update Workflow Definition, so it round-trips.
The definition's version is the workflow's own counter. Leave it as it comes back: sending it unchanged on update is what stops a concurrent edit in the builder from being silently overwritten.
Endpoint: GET /workflows/{workflowId}/definition (Version header: v3; source: v3/workflows-v3.json)
OAuth scopes: workflows.readonly
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| locationId | Yes | Sub-account (location) ID the workflow belongs to | |
| workflowId | Yes | Workflow ID |