---
title: "Get group points ledger"
method: GET
path: "/v2/customers/{id}/crossMemberLedger"
---

# Get group points ledger

`GET /v2/customers/{id}/crossMemberLedger`

Retrieve a paginated history of group point redemptions and reversals for a group or for a specific member within their group.

## Path parameters

- `id` integer, required

## Query parameters

- `scope` string
- `eventName` string
- `transactionRef` string
- `startDate` string
- `endDate` string
- `pageNumber` integer
- `pageSize` integer
- `sort` string
- `programId` integer

## Headers

- `Authorization` string
- `X-CAP-API-OAUTH-TOKEN` string

## Response `200`

Successful response

- object
  - `groupDetails` object
    - `groupId` integer
    - `groupBalance` number
    - `memberCount` integer
    - `members` object[]
      - `customerId` integer
      - `balance` number
  - `pageDetails` object
    - `pageNumber` integer
    - `pageSize` integer
    - `totalEntries` integer
    - `pageCount` integer
  - `entries` object[]
    - `eventLogId` integer
    - `eventName` 'CROSS_MEMBER_REDEMPTION' | 'CROSS_MEMBER_REDEMPTION_REVERSAL'
    - `transactingCustomerId` integer
    - `transactionRef` string
    - `createdDate` string
    - `createdDateISO` string
    - `netPointsOnEvent` string
    - `status` 'ACTIVE' | 'REVERSED' | 'PARTIALLY_REVERSED'
    - `userRole` 'TRANSACTING' | 'SOURCE' | 'BOTH'
    - `redemptionId` string
    - `reversalId` string
    - `transactionNumber` string
    - `externalReferenceNumber` string
    - `notes` string
    - `redemptionPurpose` string
    - `entryDetails` object[]
      - `customerId` integer
      - `points` string
      - `reversedAmount` string
      - `expiryBatchDate` string
      - `status` 'ACTIVE' | 'REVERSED' | 'PARTIALLY_REVERSED'
      - `pointsAwardedId` integer
      - `pointsAwardedType` 'POINT_AWARDED' | 'POINT_AWARDED_BILL_PROMOTION' | 'POINT_AWARDED_LINEITEM' | 'POINT_AWARDED_LINEITEM_PROMOTION' | 'POINT_AWARDED_CUSTOMER_PROMOTION'
  - `warnings` object[]

## Other responses

- `400` — Validation error
- `401` — Unauthorized — invalid or missing credentials
- `404` — Customer not enrolled in a cross-member group

---

[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)
