---
title: "Retrieve group ledger information (Available in points ledger)"
method: GET
path: "/pointsLedger/getCustomerLedgerInfo"
---

# Retrieve group ledger information (Available in points ledger)

`GET /pointsLedger/getCustomerLedgerInfo`

This API allows you to retrieve the ledger information of the group.

## Query parameters

- `source` string, required
- `identifierName` string, required
- `identifierValue` string, required
- `type` string, required
- `limit` string
- `offset` string

## Response `200`

200

- object
  - `ledgerDetails` object
    - `pageNumber` integer
    - `pageSize` integer
    - `totalEntries` integer
    - `pageCount` integer
  - `ledgerEntries` object[]
    - `eventLogId` integer
    - `eventName` string
    - `customerId` integer
    - `ledgerCreatedDate` string
    - `customerDetails` unknown
    - `entryDetails` object[]
      - `ledgerEntryType` string
      - `points` string
      - `pointsCategory` string
      - `programName` string
      - `programId` integer
    - `netPointsOnEvent` string
    - `transactionDetails` object
    - `store` string
    - `storeCode` string
    - `tillCode` string
    - `eventDetails` object
      - `reason` string
  - `warnings` unknown[]
    - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)