> ## Documentation Index
> Fetch the complete documentation index at: https://developers.clay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get workspace credit balances

> Returns the current credit balances for the workspace associated with the API key. Reading balances does not consume credits.



## OpenAPI

````yaml /openapi.json get /credits/balance
openapi: 3.1.0
info:
  contact:
    name: Clay
    url: https://www.clay.com
  description: Programmatic access to Clay.
  title: Clay Public API
  version: '0'
servers:
  - description: production
    url: https://api.clay.com/public/v0
security:
  - ClayApiKey: []
tags:
  - description: Authenticated user and workspace endpoints.
    name: me
  - description: Workspace credit balances.
    name: credits
  - description: Search creation and pagination endpoints.
    name: search
  - description: Structured table query endpoints.
    name: tables
  - description: Routine discovery and execution endpoints.
    name: routines
  - description: Workflow-run query endpoints.
    name: workflowsRuns
paths:
  /credits/balance:
    get:
      tags:
        - credits
      summary: Get workspace credit balances
      description: >-
        Returns the current credit balances for the workspace associated with
        the API key. Reading balances does not consume credits.
      operationId: getCreditBalance
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  action_execution_balance:
                    description: >-
                      Remaining actions. Omitted for workspaces on legacy
                      billing plans or without a billing plan.
                    type: number
                  balance:
                    description: >-
                      Total remaining spendable data credits, including rollover
                      credits.
                    type: number
                required:
                  - balance
                type: object
          description: '200'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: '401'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: '403'
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: '429'
components:
  schemas:
    ErrorResponse:
      additionalProperties: false
      properties:
        message:
          type: string
      required:
        - message
      type: object
  securitySchemes:
    ClayApiKey:
      description: >-
        Personal API key tied to your Clay user. Create one under Settings →
        Account in the Clay app.
      in: header
      name: clay-api-key
      type: apiKey

````