---
title: "Read workspace usage"
method: GET
path: "/v1/workspaces/{workspace}/usage"
---

# Read workspace usage

`GET /v1/workspaces/{workspace}/usage`

## Request

- Base URL: `https://api.uploads.sh`
- URL: `https://api.uploads.sh/v1/workspaces/{workspace}/usage`
- Auth: HTTP bearer

## Response `200`

Usage counters, configured limits, credential scopes, and plan.

- Usage
  - `workspace` string, required
  - `bytes` integer, required
  - `objects` integer, required
  - `sharedBytes` integer
  - `sharedObjects` integer
  - `uploadsInPeriod` integer, required
  - `periodStart` string, date-time
  - `updatedAt` string, date-time
  - `scopes` string[], required
  - `plan` string, required
  - `maxStorageBytes` integer
  - `storageRemainingBytes` integer
  - `maxUploadsPerPeriod` integer
  - `uploadsRemaining` integer

## Other responses

- `401`: Missing or invalid credential.
- `403`: The credential lacks the required scope or role.

---

[API](https://skmtc.dev/uploads/apis/uploads-sh-api.md) · [All operations](https://skmtc.dev/uploads/apis/uploads-sh-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uploads/apis/uploads-sh-api/revisions/6df242babacd?raw)
