---
title: "Get the workspace plan and usage"
method: GET
path: "/api/v1/account/workspace-plan"
tags: ["Account"]
---

# Get the workspace plan and usage

`GET /api/v1/account/workspace-plan`

## Request

- Base URL: `https://api.dotsy.ai`
- URL: `https://api.dotsy.ai/api/v1/account/workspace-plan`
- Auth: HTTP bearer

The active workspace's plan, how many free sites it can hold, how many Pro and password-protected sites it has, and how many free workspaces the signed-in person owns. Any member may read it. A `pga_` key has no person, so `freeWorkspaces.owned` is 0. Not polled — the workspace settings page loads it.

## Headers

- `X-Dotsy-Workspace` string

## Response `200`

The workspace plan and usage.

- WorkspacePlanView
  - `workspaceId` string, required
  - `plan` 'free' | 'core', required
  - `freeSites` object, required
    - `used` integer, required
    - `max` integer, required
    - `base` integer, required
    - `perPaid` integer, required
  - `paidSites` integer, required: Sites in this workspace on the Pro plan.
  - `protectedSites` integer, required: Sites in this workspace whose access is password.
  - `freeWorkspaces` object, required
    - `owned` integer, required: Free workspaces this person owns. Invited memberships are not counted.
    - `limit` integer, required

## Other responses

- `401`: Missing or invalid credentials.
- `403`: `forbidden_workspace`: you are not a member of the workspace named in `X-Dotsy-Workspace`.

---

[API](https://skmtc.dev/dotsy/apis/dotsy-api.md) · [All operations](https://skmtc.dev/dotsy/apis/dotsy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dotsy/apis/dotsy-api/revisions/4272ed3b85d7?raw)