# Get storage usage

Read workspace storage usage in bytes, with shared, per-member and total usage against the plan allowance.

POST https://api.brigg.app/v1/operations/billing.GetStorageUsage

## Access & visibility

Allow `billing.GetStorageUsage` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request

No parameters. Send an empty JSON object (`{}`).

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `plan` | string | Yes | Current workspace subscription plan. |
| `quota_bytes` | number | Yes | Storage allowance for the workspace, in bytes. |
| `used_bytes` | number | Yes | Total storage currently used, in bytes. |
| `shared_bytes` | number | Yes | Storage used by workspace-shared content, in bytes. |
| `user_bytes` | number | Yes | Storage used by personal content, in bytes. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/billing.GetStorageUsage' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/billing.GetStorageUsage", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/billing.GetStorageUsage",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "plan": "team",
  "quota_bytes": 10737418240,
  "used_bytes": 1610612736,
  "shared_bytes": 1073741824,
  "user_bytes": 536870912
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "plan": {
      "type": "string",
      "description": "Current workspace subscription plan."
    },
    "quota_bytes": {
      "type": "number",
      "description": "Storage allowance for the workspace, in bytes."
    },
    "used_bytes": {
      "type": "number",
      "description": "Total storage currently used, in bytes."
    },
    "shared_bytes": {
      "type": "number",
      "description": "Storage used by workspace-shared content, in bytes."
    },
    "user_bytes": {
      "type": "number",
      "description": "Storage used by personal content, in bytes."
    }
  },
  "required": [
    "plan",
    "quota_bytes",
    "used_bytes",
    "shared_bytes",
    "user_bytes"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "plan": "team",
      "quota_bytes": 10737418240,
      "used_bytes": 1610612736,
      "shared_bytes": 1073741824,
      "user_bytes": 536870912
    }
  ]
}
```