---
title: "Get workspace credit balances"
method: GET
path: "/credits/balance"
tags: ["credits"]
---

# Get workspace credit balances

`GET /credits/balance`

## Request

- Base URL: `https://api.clay.com/public/v0`
- URL: `https://api.clay.com/public/v0/credits/balance`
- Auth: API key in header `clay-api-key`

Returns the current credit balances for the workspace associated with the API key, and the key owner's personal monthly credit limit. Reading balances does not consume credits.

## Response `200`

200

- object
  - `action_execution_balance` number: Remaining actions. Omitted for workspaces on legacy billing plans or without a billing plan.
  - `balance` number, required: Total remaining spendable data credits, including rollover credits.
  - `user` object: The API key owner, with their personal monthly credit limit.
    - `balance` number, nullable, required: Credits left this month. Null when no personal limit is set.
    - `email` string, nullable
    - `id` string, required
    - `limit` number, nullable, required: Credits allowed per month. Null when no personal limit is set.
    - `name` string, nullable, required

## Other responses

- `401`: 401
- `403`: 403
- `429`: 429

## Changes

- **2026-11-04** `583f58ced7f1`: 1 info
  - added the optional property `user` to the response with the `200` status
- **2026-09-11** `4f32cfdc7b57`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/clay/apis/clay-public-api/changes/credits/balance/get.md)

---

[API](https://skmtc.dev/clay/apis/clay-public-api.md) - [All operations](https://skmtc.dev/clay/apis/clay-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clay/apis/clay-public-api/revisions/583f58ced7f1?raw)