---
title: "List workspace plans"
description: "GET /admin/v1/workspaces/{workspaceId}/plans — List workspace plans"
---

> Documentation Index
> Fetch the complete documentation index at: https://nexus.microvoid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List workspace plans

## Endpoint

```http
GET /admin/v1/workspaces/{workspaceId}/plans
```

Operation ID: `listPlans`

## Authentication

Send a Nexus Management Key as `Authorization: Bearer <management-key>`. This credential is control-plane only.

## Idempotency

This operation does not declare an `Idempotency-Key` requirement in the accepted OpenAPI contract.

## Request

### Parameters

| Name          | Location | Required | Schema   | Description |
| ------------- | -------- | -------- | -------- | ----------- |
| `workspaceId` | path     | Yes      | `string` | —           |
| `cursor`      | query    | No       | `string` | —           |
| `limit`       | query    | No       | `number` | —           |

### Body

_This operation has no request body._

## Responses

| Status | Description | Content type     | Schema                    |
| ------ | ----------- | ---------------- | ------------------------- |
| `200`  | —           | application/json | `array<WorkspacePlanDto>` |

Only responses explicitly declared by the accepted Admin OpenAPI contract are shown. The current contract does not declare operation-specific error bodies; the SDK preserves any non-success status and body in [`AdminApiError`](/management-sdk/error-handling).

### `200` application/json schema

Type: `array<WorkspacePlanDto>`

| Field                | Required | Type                                   | Description |
| -------------------- | -------- | -------------------------------------- | ----------- |
| `[].id`              | Yes      | `string`                               | —           |
| `[].workspaceId`     | Yes      | `string`                               | —           |
| `[].key`             | Yes      | `string`                               | —           |
| `[].name`            | Yes      | `string`                               | —           |
| `[].billingInterval` | Yes      | `string (MONTH \| YEAR)`               | —           |
| `[].status`          | Yes      | `string (DRAFT \| ACTIVE \| ARCHIVED)` | —           |

## Examples

### TypeScript Management SDK

`NexusAdminClient.listPlans` uses `AdminOperationInput<"listPlans">` and returns `Promise<AdminOperationOutput<"listPlans">>`.

```ts
import { NexusAdminClient } from '@nexus/sdk-typescript';

const nexus = new NexusAdminClient({
  baseUrl: 'https://nexus.microvoid.io',
  managementKey: process.env.NEXUS_MANAGEMENT_KEY,
});

const result = await nexus.listPlans({
  path: {
    workspaceId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
});
```

### Fetch

```ts
const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/plans',
  {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
    },
  },
);

if (!response.ok) throw new Error(`Nexus request failed: ${response.status}`);
```

### curl

```bash
curl --request GET \
  "https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/plans" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}"
```

## Related guide

- [Workspace plans](/docs/control-plans-and-quota/workspace-plans)
- [API Reference overview](/api-reference)

Source: https://nexus.microvoid.io/api-reference/admin/plans-and-strategies/list-plans/index.mdx