---
title: Get the bucket summary
description: Returns every bucket in the workspace with its usage and indexing counts, in one call.
doc_version: 0.1.0-preview
last_updated: 2026-09-14
---

# Get the bucket summary

`GET /v1/workspaces/{workspaceId}/bucket-summary`

Returns every bucket in the workspace with its usage and indexing counts, in one call. A bucket that is not active, or that could not be read, has null usage and index. A bucket with indexing disabled has null index. Role: viewer or higher.

## Authentication

Send `Authorization: Bearer <GRAPHON_API_KEY>`. Read the key from the
GRAPHON_API_KEY environment variable. Never print it.

## Path parameters

- `workspaceId` (string) — The workspace id.

## Example request

```bash
curl \
  --url "https://storage.beta.graphon.sh/v1/workspaces/wspq7ws2np5l8z4/bucket-summary" \
  --header "Authorization: Bearer $GRAPHON_API_KEY"
```

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.