---
title: "Read this period's Energy balance"
method: GET
path: "/energy"
tags: ["Account"]
---

# Read this period's Energy balance

`GET /energy`

## Request

- Base URL: `https://app.pumpgtm.com/api/v1`
- URL: `https://app.pumpgtm.com/api/v1/energy`
- Auth: HTTP bearer

Energy for the current month on a metered workspace: allowance, used, remaining, per-action costs and cents per Energy. { enabled: false } when the workspace is not metered. Partner end users draw from the partner's pool. A balance is not a reservation.

## Headers

- `X-PumpGTM-Client` string, uuid
- `X-PumpGTM-User` string

## Response `200`

Successful response. Read outcome fields; success does not imply delivery.

- object
  - `enabled` boolean, required
  - `used` integer
  - `remaining` integer
  - `periodStart` string
  - `costs` object
  - `centsPerEnergy` number

## Other responses

- `400`: Invalid input; for partner keys also user_header_required when the account requires X-PumpGTM-User
- `401`: Missing, invalid or revoked key
- `403`: Workspace mismatch, channel or feature disabled; for partner keys also enterprise_required and user_disabled
- `404`: Resource unavailable in this workspace
- `409`: Revision, identity or state conflict: { error, message } and nothing changed
- `429`: Rate limit; respect Retry-After when provided
- `500`: internal_error: an unexpected failure on our side; retry, then contact PumpGTM
- `503`: Dependency unavailable; identity may be unknown

## Changes

- **2026-10-12** `06d2e4d0e84b`: 8 info
  - the response property `error` became required for the status `400`
  - the response property `error` became required for the status `401`
  - the response property `error` became required for the status `403`
  - the response property `error` became required for the status `404`
  - …4 more
- **2026-10-12** `08c80059d483`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/changes/energy/get.md)

---

[API](https://skmtc.dev/pumpgtm/apis/pumpgtm-api.md) - [All operations](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/revisions/06d2e4d0e84b?raw)