---
title: "List Campaign Pending Points"
method: GET
path: "/v1/loyalties/{campaignId}/pending-points"
tags: ["Loyalties"]
---

# List Campaign Pending Points

`GET /v1/loyalties/{campaignId}/pending-points`

Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned.

>👍 Configuring pending points
>
>Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).

## Query parameters

- `limit` integer
- `order` 'id' | '-id'
- `starting_after_id` string

## Response `200`

Returns all pending point entries for all loyalty cards in the campaign.

- LoyaltiesPendingPointsListResponseBody — Lists pending point entries.
  - `object` 'list', required — The type of the object represented by JSON.
  - `data_ref` 'data', required — Identifies the name of the attribute that contains the array of pending point objects.
  - `data` LoyaltyPendingPoints[], required — A dictionary that contains an array of pending point entries. Each entry in the array is a separate pending point object.
    - `id` string, required — Unique identifier of the pending point entry, assigned by Voucherify.
    - `voucher_id` string, required — Unique identifier of the loyalty card, assigned by Voucherify.
    - `campaign_id` string, required — Unique campaign identifier, assigned by Voucherify.
    - `customer_id` string, required — Unique customer identifier, assigned by Voucherify.
    - `order_id` string, required — Unique order identifier, assigned by Voucherify.
    - `points` integer, required — Number of points in the pending state.
    - `activates_at` string, date, required — Date when the pending points are activated and added to the customer's loyalty card.
    - `details` LoyaltyPendingPointsDetails, required — Details about how the pending points were earned.
      - `loyalty_tier` object — The loyalty tier that is mapped for the earning rule and used in the pending point transaction.
        - `id` string, required — Unique identifier of the loyalty tier, assigned by Voucherify.
        - `name` string, required — User-defined name of the loyalty tier.
      - `holder_loyalty_tier` object — Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was at the moment pending points were created.
        - `id` string, required — Unique identifier of the loyalty tier, assigned by Voucherify.
        - `name` string, required — User-defined name of the loyalty tier.
      - `event` object, required — Details about the event that created pending points.
        - `id` string — Unique event identifier, assigned by Voucherify.
        - `type` 'customer.order.paid' — Type of the event that triggered the creation of pending points.
        - `group_id` string — Unique identifier of the request that triggered the event, assigned by Voucherify.
        - `entity_id` string — Unique identifier of the entity that triggered the event, assigned by Voucherify. For pending points, it is the `customer_id` of the customer who paid for the order.
        - `created_at` string, date-time — Timestamp representing the date and time when the event occurred. The value is shown in the ISO 8601 format.
        - `category` 'ACTION' | 'EFFECT' — Type of the event.
        - `event_source` EventSource — Contains the source of the object that initiated the event.
          - `channel` 'USER_PORTAL' | 'API' | 'CLIENT_API' | 'INTERNAL', required — Determines the channel that initiated the event.
          - `user` object — Determines the Voucherify user who triggered the event.
            - `id` string, required — Unique identifier of the user.
          - `api_key` object — Determines the API key used to initiate the event.
            - `name` string, required — Channel name in the application keys.
            - `app_id` string, required — Contains the application ID from the Voucherify API key pair.
      - `earning_rule` object, required — Contains information about the earning rule.
        - `id` string, required — Unique identifier of an earning rule, assigned by Voucherify.
        - `source` object, required — Contains the custom earning rule name.
          - `banner` string, required — Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.
      - `order` object, required — Details about the order that caused adding pending points.
        - `id` string, required — Unique order identifier, assigned by Voucherify.
        - `source_id` string, nullable, required — User-defined order identifier.
    - `created_at` string, date-time, required — Timestamp representing the date and time when the pending point entry was created. The value is shown in the ISO 8601 format.
    - `updated_at` string, date-time — Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format.
  - `has_more` boolean, required — As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.
  - `more_starting_after` string — Returns an ID that can be used to return another page of results. Use the pending point entry ID in the `starting_after_id` query parameter to display another page of the results starting after the entry with that ID.

## Other responses

- `404` — Returns an error if the campaign could not be found.

---

[API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/versions/4982266e0494/schema)