API reference/Automation/Operations

GETLive

Get operation

Returns the status and result references for an async operation.

/v1/operations/{operationId}

Authorization

Credential

oauth_user_or_client

Required scopes

operations:read

Path parameters

operationId

string · required

Implementation note

Supports ?wait=<seconds> (bounded to 30) to long-poll: the response is held until the operation reaches a terminal state (succeeded/failed) or the wait elapses, then returns the current state either way. Omit ?wait for an immediate snapshot.

Error responses

401Authentication required

No valid credentials were supplied. Attach a Bearer access token and retry.

402Upgrade required

The authenticated user's plan does not include this capability. `feature` names the gated capability, `requiredPlan` the cheapest plan that unlocks it, `currentPlan` the user's plan today, and `upgradeUrl` links to checkout. This is a plan gate, not a transient error — retrying without upgrading fails again; surface `upgradeUrl` to the user instead. Dormant until a plan that grants the feature is active, so a route that documents it may not currently return it.

403Insufficient scope

The token is valid but lacks the OAuth scope (or token kind) this endpoint requires.

404Resource not found

The addressed resource does not exist, or is not visible to the caller.