Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1411163326.7 KB
Workflow

Get a workflow

Returns summary fields of a workflow by ID.

get/workflow/{id}

Path parameters

idstring uuid required

The unique ID of the workflow.

Response

A workflow object.

pipeline_idstring uuid required

The ID of the pipeline this workflow belongs to.

canceled_bystring uuid

The ID of the user who canceled the workflow.

idstring uuid required

The unique ID of the workflow.

auto_rerun_numberinteger

Present if this workflow was auto-rerun from a previous workflow. The Nth auto-rerun workflow will have auto_rerun_number N.

namestring required

The name of the workflow.

project_slugstring required

The project-slug for the pipeline this workflow belongs to.

errored_bystring uuid

The ID of the user associated with the error on the workflow.

tag'setup' nullable

Tag used for the workflow.

status'success' | 'canceled' | 'error' | 'failed' | 'failing' | 'not_run' | 'on_hold' | 'running' | 'unauthorized' required

The current status of the workflow.

started_bystring uuid required

The ID of the user who started the workflow.

max_auto_rerunsinteger

The maximum number of auto reruns specified for the workflow.

pipeline_numberinteger required

The number of the pipeline this workflow belongs to.

created_atstring date-time required

The date and time the workflow was created.

stopped_atstring date-time nullable required

The date and time the workflow stopped.

Example response

{
  "pipeline_id": "5034460f-c7c4-4c43-9457-de07e2029e7b",
  "canceled_by": "026a6d28-c22e-4aab-a8b4-bd7131a8ea35",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "auto_rerun_number": 1,
  "name": "build-and-test",
  "project_slug": "gh/CircleCI-Public/api-preview-docs",
  "errored_by": "c6e40f70-a80a-4ccc-af88-8d985a7bc622",
  "tag": "setup",
  "started_by": "03987f6a-4c27-4dc1-b6ab-c7e83bb3e713",
  "max_auto_reruns": 5,
  "pipeline_number": 25
}