---
title: "Retrieve Residential Ledger"
method: GET
path: "/public/user/residential_ledger/retrieve/{residential_ledger_id}"
tags: ["Residential Ledger"]
---

# Retrieve Residential Ledger

`GET /public/user/residential_ledger/retrieve/{residential_ledger_id}`

## Request

- Base URL: `https://api.byteful.com/1.0`
- URL: `https://api.byteful.com/1.0/public/user/residential_ledger/retrieve/{residential_ledger_id}`
- Auth: API key in header `X-API-Private-Key` and API key in header `X-API-Public-Key`
- TypeScript: <https://skmtc.dev/byteful/apis/byteful-public-user-api/docs/public/user/residential_ledger/retrieve/:residential_ledger_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a specific Residential Ledger based on the provided ID for the current user's account.

## Path parameters

- `residential_ledger_id` string, required

## Response `200`

Successful Residential Ledger Retrieve

- ResidentialLedgerSuccessfulRetrieveResponse: Residential Ledger retrieve was successful.
  - `data` object: Retrieved Residential Ledger item details.
    - `customer_id` integer
    - `residential_ledger_bytes` integer
    - `residential_ledger_creation_datetime` string, date-time
    - `residential_ledger_id` string
    - `residential_ledger_last_update_datetime` string, date-time
    - `residential_ledger_period_date` string
    - `residential_ledger_reason` string
    - `residential_ledger_requests` integer
    - `service_adjustment_id` integer
    - `service_id` string
  - `message` string: Status message for the retrieval.

---

[API](https://skmtc.dev/byteful/apis/byteful-public-user-api.md) - [All operations](https://skmtc.dev/byteful/apis/byteful-public-user-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byteful/apis/byteful-public-user-api/revisions/3db1a6fc0099?raw)