Skip to content
forgit api docs

List steps for a pipeline

GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps

Find steps for the given pipeline.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug
required
string

The repository.

pipeline_uuid
required
string

The UUID of the pipeline.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The steps.

Media type application/json
Paginated Pipeline Steps

A paged list of pipeline steps.

object
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
values

The values of the current page.

Array
0
object
type
required
string
uuid

The UUID identifying the step.

string
started_on

The timestamp when the step execution was started. This is not set when the step hasn’t executed yet.

string format: date-time
completed_on

The timestamp when the step execution was completed. This is not set if the step is still in progress.

string format: date-time
state
object
type
required
string
image
Pipeline Image

The definition of a Docker image that can be used for a Bitbucket Pipelines step execution context.

object
name

The name of the image. If the image is hosted on DockerHub the short name can be used, otherwise the fully qualified name is required here.

string
username

The username needed to authenticate with the Docker registry. Only required when using a private Docker image.

string
password

The password needed to authenticate with the Docker registry. Only required when using a private Docker image.

string
email

The email needed to authenticate with the Docker registry. Only required when using a private Docker image.

string
setup_commands

The list of commands that are executed as part of the setup phase of the build. These commands are executed outside the build container.

Array<object>
Pipeline Command

An executable pipeline command.

object
name

The name of the command.

string
command

The executable command.

string
script_commands

The list of build commands. These commands are executed in the build container.

Array<object>
Pipeline Command

An executable pipeline command.

object
name

The name of the command.

string
command

The executable command.

string
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
Example generated 
{
  "page": 1,
  "values": [
    {
      "type": "example",
      "uuid": "example",
      "started_on": "2026-04-15T12:00:00Z",
      "completed_on": "2026-04-15T12:00:00Z",
      "state": {
        "type": "example"
      },
      "image": {
        "name": "example",
        "username": "example",
        "password": "example",
        "email": "example"
      },
      "setup_commands": [
        {
          "name": "example",
          "command": "example"
        }
      ],
      "script_commands": [
        {
          "name": "example",
          "command": "example"
        }
      ]
    }
  ],
  "size": 1,
  "pagelen": 1,
  "next": "https://example.com",
  "previous": "https://example.com"
}