---
title: "Get a list of stages"
method: GET
path: "/stages"
tags: ["Stagesets (Pipelines)"]
---

# Get a list of stages

`GET /stages`

Returns active stages from active pipelines that are visible to the authenticated user. OAuth access tokens require the read scope. When pipeline visibility is enabled, stages in restricted pipelines are omitted unless the authenticated user is an administrator or the pipeline is shared directly or through a team.

## Response `200`

Stages visible to the authenticated user.

- object
  - `meta` Meta, required — Information about the Nutshell instance making the request
    - `instanceId` string — The Nutshell instance ID
    - `siteId` string — Site ID for WebFX customers
  - `links` object, required — Top-level relationship metadata for stage pipelines.
  - `stages` object[], required
    - `id` string, required
    - `type` 'stages', required
    - `name` string, required
    - `description` string, required
    - `position` integer, required
    - `activeAvatarUrl` string, uri, required
    - `completeAvatarUrl` string, uri, required
    - `incompleteAvatarUrl` string, uri, required
    - `overdueAvatarUrl` string, uri, required
    - `links` object, required
      - `stageset` string, required

## Other responses

- `401` — Authentication required.
- `403` — The OAuth access token does not include the read scope.

---

[API](https://skmtc.dev/nutshell/apis/nutshell-api.md) · [All operations](https://skmtc.dev/nutshell/apis/nutshell-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nutshell/nutshell-api/revisions/14f59cf6a09a/schema)