---
title: "Get workspace runners"
method: GET
path: "/workspaces/{workspace}/pipelines-config/runners"
tags: ["Pipelines"]
---

# Get workspace runners

`GET /workspaces/{workspace}/pipelines-config/runners`

Retrieve workspace runners.

## Path parameters

- `workspace` string, required

## Response `200`

The workspace runners.

- PaginatedPipelineRunners — A paged list of runners.
  - `page` integer — Page number of the current results. This is an optional element that is not provided in all responses.
  - `values` PipelineRunner[] — The values of the current page.
    - `type` string, required
    - `uuid` string — The UUID identifying the runner.
    - `name` string — The name of the runner.
    - `labels` string[] — Labels assigned to the runner for identification and routing.
    - `state` PipelineRunnerState — The state information of a runner.
      - `type` string, required
      - `status` 'UNREGISTERED' | 'ONLINE' | 'OFFLINE' | 'DISABLED' | 'ENABLED' | 'UNHEALTHY' — The current status of the runner.
      - `version` PipelineRunnerVersion — Version information for a runner.
        - `type` string, required
        - `version` string — The currently installed version of the runner.
        - `current` string — The current recommended version of the runner.
      - `updated_on` string, date-time — The timestamp when the runner state was last updated.
      - `cordoned` boolean — Whether the runner is cordoned (prevented from accepting new steps).
    - `created_on` string, date-time — The timestamp when the runner was created.
    - `updated_on` string, date-time — The timestamp when the runner was last updated.
    - `oauth_client` PipelineRunnerOauthClient — OAuth client configuration for runner authentication.
      - `type` string, required
      - `id` string — The OAuth client ID.
      - `secret` string — The OAuth client secret. This is an optional element that is only provided once.
      - `token_endpoint` string, uri — The OAuth token endpoint URL.
      - `audience` string — The intended audience for the OAuth token.
  - `size` integer — 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.
  - `pagelen` integer — 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.
  - `next` string — 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.
  - `previous` string — 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.

---

[API](https://skmtc.net/bitbucket/apis/bitbucket-api.md) · [All operations](https://skmtc.net/bitbucket/apis/bitbucket-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitbucket/bitbucket-api/versions/7e9be973015d/schema)
