Skip to content

Get workflow run status

client.WorkflowRun.Status(ctx, runID) (*WorkflowRunStatusResponse, error)
GET/v1/workflowRun/{runId}/status

Returns the current status of a workflow run. This endpoint does not require authentication: possession of the run ID grants access to its status, so keep run IDs private. No run inputs, outputs or workspace details are returned.

ParametersExpand Collapse
runID string

Unique identifier of the workflow run.

ReturnsExpand Collapse
type WorkflowRunStatusResponse struct{…}
Status string

Current status of the workflow run (for example, STARTED, COMPLETED or FAILED).

Get workflow run status

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  workflowRunStatusResponse, err := client.WorkflowRun.Status(context.TODO(), "runId")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", workflowRunStatusResponse.Status)
}
{
  "status": "status"
}
Returns Examples
{
  "status": "status"
}