---
title: "Get a workflow"
method: GET
path: "/workflow/{id}"
tags: ["Workflow"]
---

# Get a workflow

`GET /workflow/{id}`

## Request

- Base URL: `https://circleci.com/api/v2`
- URL: `https://circleci.com/api/v2/workflow/{id}`
- Auth: one of:
  - API key in header `Circle-Token`
  - HTTP bearer
  - HTTP basic
  - API key in query parameter `circle-token`

Returns summary fields of a workflow by ID.

## Path parameters

- `id` string, uuid, required

## Response `200`

A workflow object.

- Workflow
  - `pipeline_id` string, uuid, required: The ID of the pipeline this workflow belongs to.
  - `canceled_by` string, uuid: The ID of the user who canceled the workflow.
  - `id` string, uuid, required: The unique ID of the workflow.
  - `auto_rerun_number` integer: Present if this workflow was auto-rerun from a previous workflow. The Nth auto-rerun workflow will have auto_rerun_number N.
  - `name` string, required: The name of the workflow.
  - `project_slug` string, required: The project-slug for the pipeline this workflow belongs to.
  - `errored_by` string, 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_by` string, uuid, required: The ID of the user who started the workflow.
  - `max_auto_reruns` integer: The maximum number of auto reruns specified for the workflow.
  - `pipeline_number` integer, required: The number of the pipeline this workflow belongs to.
  - `created_at` string, date-time, required: The date and time the workflow was created.
  - `stopped_at` string, date-time, nullable, required: The date and time the workflow stopped.

## Other responses

- `400`: Workflow ID provided is invalid.
- `401`: Credentials provided are invalid.
- `404`: Entity not found.
- `429`: API rate limits exceeded.
- `500`: Internal server error.

---

[API](https://skmtc.dev/circleci/apis/circleci-api.md) - [All operations](https://skmtc.dev/circleci/apis/circleci-api/llms.txt) - [OpenAPI document](https://skmtc.dev/circleci/apis/circleci-api/revisions/b9c0e0c24058?raw)