---
title: "Get Workspace Usage"
method: GET
path: "/v1/portal/workspace/usage"
tags: ["portal"]
---

# Get Workspace Usage

`GET /v1/portal/workspace/usage`

## Request

- Base URL: `https://api.beeble.ai`
- URL: `https://api.beeble.ai/v1/portal/workspace/usage`
- Auth: HTTP bearer

Product API credits for the active workspace (personal or organization).

## Query parameters

- `start_date` string, date, nullable
- `end_date` string, date, nullable
- `product` string, nullable
- `model_id` string, nullable
- `api_key_id` string, nullable
- `user_id` string, nullable
- `team_id` string, nullable

## Headers

- `authorization` string

## Response `200`

Successful Response

- PortalUsageResponse
  - `gross_credits` integer
  - `refunded_credits` integer
  - `net_credits` integer
  - `organization_id` string, nullable
  - `scope` 'organization' | 'member' | 'personal', required
  - `start_date` string, date, required
  - `end_date` string, date, required
  - `daily_usage` PortalDailyUsage[]
    - `gross_credits` integer
    - `refunded_credits` integer
    - `net_credits` integer
    - `date` string, date, required
  - `by_product` PortalProductUsage[]
    - `gross_credits` integer
    - `refunded_credits` integer
    - `net_credits` integer
    - `product` string, required
    - `model_id` string, required
  - `by_api_key` PortalKeyUsage[]
    - `gross_credits` integer
    - `refunded_credits` integer
    - `net_credits` integer
    - `api_key_id` string, nullable
    - `api_key_name` string, nullable
    - `api_key_hint` string, nullable
  - `by_user` PortalUserUsage[]
    - `gross_credits` integer
    - `refunded_credits` integer
    - `net_credits` integer
    - `user_id` string, required
    - `display_name` string, nullable
  - `by_team` PortalTeamUsage[]
    - `gross_credits` integer
    - `refunded_credits` integer
    - `net_credits` integer
    - `team_id` string, nullable
    - `team_name` string, nullable
  - `usage_records` integer
  - `is_partial` boolean
  - `scanned_records` integer
  - `max_records` integer, required

## Changes

- **2026-11-13** `0c4362818fd3`: 2 info
  - added the new optional `query` request parameter `team_id`
  - added the optional property `by_team` to the response with the `200` status
- **2026-10-02** `a9ab2752bcd8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/beeble/apis/beeble-developer-api/changes/v1/portal/workspace/usage/get.md)

---

[API](https://skmtc.dev/beeble/apis/beeble-developer-api.md) - [All operations](https://skmtc.dev/beeble/apis/beeble-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beeble/apis/beeble-developer-api/revisions/0c4362818fd3?raw)