---
title: "GET /v1/workspaces/{workspaceId}/usage/ledger"
method: GET
path: "/v1/workspaces/{workspaceId}/usage/ledger"
tags: ["Usage"]
---

# GET /v1/workspaces/{workspaceId}/usage/ledger

`GET /v1/workspaces/{workspaceId}/usage/ledger`

## Request

- Base URL: `https://api.atlas-compiler.com`
- URL: `https://api.atlas-compiler.com/v1/workspaces/{workspaceId}/usage/ledger`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `workspaceId` string, required

## Query parameters

- `limit` integer
- `cursor` string
- `metric` 'credits'
- `projectId` string

## Response `200`

Immutable usage ledger.

- object
  - `data` object[], required
    - `consumedDelta` integer, required
    - `createdAt` string, date-time, required
    - `entryType` 'reserve' | 'settle' | 'release' | 'adjustment' | 'credit', required
    - `eventKey` string, required
    - `id` string, required
    - `metadata` object, nullable, required: Intentionally open JSON metadata emitted by the usage ledger.
    - `metric` 'credits', required
    - `periodStart` string, date-time, required
    - `reservationId` string, nullable, required
    - `reservedDelta` integer, required
    - `source` string, required
  - `nextCursor` string, nullable, required

## Other responses

- `400`: RFC 9457 problem.
- `401`: RFC 9457 problem.
- `403`: RFC 9457 problem.
- `404`: RFC 9457 problem.
- `500`: RFC 9457 problem.
- `503`: RFC 9457 problem.

---

[API](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api.md) · [All operations](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api/revisions/a43b60619cdf?raw)