# List Stages

> Lists an approval flow's stages in board order with their rules and template counts.

- **URL**: https://orshot.com/docs/api-reference/approvals-stages-list

---

The Approvals API is available on Enterprise plans, or through first-party apps (the Orshot app and the Orshot MCP server). This endpoint needs [`read` access](/docs/api-reference/approvals-overview#access-levels).
See [Enterprise pricing](https://orshot.com/pricing) to get access.

Lists an approval flow's stages in board order with their rules and template counts. Use it to find the stage slug to move a template to.

## Endpoint

```markdown tab="Endpoint"
https://api.orshot.com/v1/approval-flows/:flow/stages
```

## Path Parameters

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `flow` | String | Yes | The approval flow's id or slug. A number is an id, anything else a slug. |

## Query Parameters

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `includeArchived` | Boolean | No | Include archived stages. Default `false`. |

## Headers

| Header | Required | Description |
| ------ | -------- | ----------- |
| `Authorization` | Yes | `Bearer <API key or OAuth token>` |
| `x-workspace-id` | No | OAuth tokens with several workspaces: the workspace to act in. API keys ignore it. |
| `X-Orshot-User-Id` | No | API keys only: the user id of the owner, admin or member this call is for. See Acting for a Team Member below. |
| `X-Session-Id` | No | Groups the calls of one agent or MCP session in the activity history. |

## Acting for a Team Member

With an API key, you can send `X-Orshot-User-Id` with the user id of an owner, admin or member of the workspace to make this call for them. The answer then follows both the key's access level and that person's own access. See [acting for a team member](https://orshot.com/docs/api-reference/approvals-overview#acting-for-a-team-member).

## Request

**Request**
```js
await fetch("https://api.orshot.com/v1/approval-flows/brand-and-legal/stages", {
  headers: { Authorization: "Bearer <ORSHOT_API_KEY>" },
});
```

**Response**
```json
{
  "stages": [
    {
      "id": 1,
      "slug": "draft",
      "name": "Draft",
      "color": null,
      "category": "open",
      "rules": {
        "editable": true,
        "render": {
          "image": false,
          "pdf": false,
          "video": false
        },
        "enter": {
          "from": "any",
          "requireComment": false,
          "requires": "contribute"
        },
        "approval": {
          "mode": "any",
          "count": 1,
          "allowSelf": false,
          "perOutput": false,
          "allowConditions": false
        },
        "next": {
          "onApproved": null,
          "onChangesRequested": null
        },
        "onEdit": "require_reapproval",
        "dueHours": null
      },
      "sortKey": "i",
      "archivedAt": null,
      "itemCount": 0
    },
    {
      "id": 2,
      "slug": "brand-review",
      "name": "Brand review",
      "color": null,
      "category": "review",
      "rules": {
        "editable": false,
        "render": {
          "image": false,
          "pdf": false,
          "video": false
        },
        "enter": {
          "from": "any",
          "requires": "contribute",
          "requireComment": false
        },
        "approval": {
          "mode": "any",
          "allowSelf": false,
          "allowConditions": false,
          "perOutput": false,
          "count": 1
        },
        "next": {
          "onApproved": "design-approved",
          "onChangesRequested": "draft"
        },
        "onEdit": "require_reapproval",
        "dueHours": null
      },
      "sortKey": "r",
      "archivedAt": null,
      "itemCount": 0
    }
  ]
}
```

## Response Fields

Responds `200` with:

| Field | Type | Description |
| ----- | ---- | ----------- |
| `stages` | Array | List of ApprovalStage, fields below. |
| `stages[].id` | Integer | Numeric id. |
| `stages[].slug` | String |  |
| `stages[].name` | String | Display name. |
| `stages[].color` | String | One of `subtle`, `blue`, `green`, `amber`, `rose`, `orange`, `purple`. The color of the stage's chips and of the dot on its board column. A stage has none by default (null): a plain chip, no dot. Can be `null`. |
| `stages[].category` | String | One of `open`, `review`, `approved`, `done`, `rejected`, `archived`. |
| `stages[].rules` | Object | Stage rules v1 with every default filled. |
| `stages[].sortKey` | String | Position in its list, as sortable text. |
| `stages[].itemCount` | Integer |  |
| `stages[].archivedAt` | String | ISO 8601 timestamp. Can be `null`. |

## Error Responses

Every error has the same body: `error`, `code`, `message` and `helpUrl`, plus the fields that apply (`required`, `role`, `context`, `blockers`, `violations`, `issues`, `current`). Branch on `error`; `code` is more specific. See the [error reference](https://orshot.com/docs/error-reference).

| Status Code | Error | Description |
| ----------- | ----- | ----------- |
| 401 | `oauth_token_invalid` | The OAuth token is invalid, expired or revoked. |
| 403 | `api_key_missing` | No `Authorization: Bearer` header. |
| 403 | `permission_denied` | You don't have access to do this. Ask an owner or admin. `code` names the capability, for example `approval.item.decide_denied`; `required` and `role` say what was missing. With `code: insufficient_scope`: the OAuth token lacks `workspace:approvals:read`. With `code: approval.member_header_not_member`: `X-Orshot-User-Id` names someone who isn't an owner, admin or member of the workspace now. With `code: approval.member_header_not_allowed`: an OAuth token sent `X-Orshot-User-Id`. |
| 403 | `plan_required` | The workspace's plan doesn't include Approvals, or doesn't include this part of it. |
| 403 | `enterprise_api_required` | Using approvals with an API key needs an Enterprise plan. Contact hi@orshot.com to turn it on. |
| 404 | `not_found` | This doesn't exist or isn't available to you. Reviewers get this, never 403, for flows and templates outside their access. |
| 422 | `validation_failed` | Some fields aren't valid: the fields listed in issues. `issues` lists each field with a path and a reason. |
| 422 | `validation_failed` | With `code: approval.member_header_invalid`: `X-Orshot-User-Id` isn't a user id. |
| 429 | `rate_limit_exceeded` | More than 120 approvals requests in a minute from one person or key. Wait for Retry-After. |
| 503 | `approvals_unavailable` | Approvals aren't available right now. Try again in a moment. Also returned while approvals are not switched on for the API. |