Skip to main content
GET
/
v1
/
loyalties
/
{campaignId}
/
pending-points
List Campaign Pending Points
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/pending-points \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "lopp_0ffdbd86f0120789f2",
      "voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
      "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
      "customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
      "order_id": "ord_0ffc73eff092dea295",
      "points": 1,
      "activates_at": "2025-01-16",
      "details": {
        "holder_loyalty_tier": {
          "id": "ltr_0e30613ad01f044515",
          "name": "Silver Tier"
        },
        "event": {
          "id": "evcus_0ffc73eff212dea29f",
          "type": "customer.order.paid",
          "group_id": "v-0ffc73efe71d5053fa",
          "entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
          "created_at": "2025-01-15T16:51:03.745Z",
          "category": "EFFECT",
          "event_source": {
            "channel": "USER_PORTAL",
            "user": {
              "id": "user_xyzaBcDEfgHOIJKLmn1opqr2Stu3VWX4"
            }
          }
        },
        "earning_rule": {
          "id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
          "source": {
            "banner": "Order-paid"
          }
        },
        "order": {
          "id": "ord_0ffc73eff092dea295",
          "source_id": "dashboard-source-20250115-001"
        }
      },
      "created_at": "2025-01-15T16:51:04.708Z"
    },
    {
      "id": "lopp_0ffd968aa8d207eb38",
      "voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
      "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
      "customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
      "order_id": "ord_0ffc4cf3aa55d28bae",
      "points": 1,
      "activates_at": "2025-01-16",
      "details": {
        "holder_loyalty_tier": {
          "id": "ltr_0e30613ad01f044515",
          "name": "Silver Tier"
        },
        "event": {
          "id": "evcus_0ffc4cf3ad15d28bb8",
          "type": "customer.order.paid",
          "group_id": "v-0ffc4cf39e2d7d9ade",
          "entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
          "created_at": "2025-01-15T14:00:43.940Z",
          "category": "EFFECT",
          "event_source": {
            "channel": "API",
            "api_key": {
              "name": "Primary",
              "app_id": "3XxxX483-0YYd-XX8z-aXXX-YYY7a3d3698"
            }
          }
        },
        "earning_rule": {
          "id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
          "source": {
            "banner": "Order-paid"
          }
        },
        "order": {
          "id": "ord_0ffc4cf3aa55d28bae",
          "source_id": "your_own_source_id_20250115-006"
        }
      },
      "created_at": "2025-01-15T14:00:44.934Z"
    },
    {
      "id": "lopp_0ffd9661bd5207eb0a",
      "voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
      "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
      "customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
      "order_id": "ord_0ffc4ccac0d5d28b7a",
      "points": 1,
      "activates_at": "2025-01-16",
      "details": {
        "holder_loyalty_tier": {
          "id": "ltr_0e30613ad01f044515",
          "name": "Silver Tier"
        },
        "event": {
          "id": "evcus_0ffc4ccac5d5d28b84",
          "type": "customer.order.paid",
          "group_id": "v-0ffc4ccaafdd50214b",
          "entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
          "created_at": "2025-01-15T14:00:02.038Z",
          "category": "EFFECT",
          "event_source": {
            "channel": "API",
            "api_key": {
              "name": "Primary",
              "app_id": "34fdc483-066d-478b-a707-be2c7a3d3698"
            }
          }
        },
        "earning_rule": {
          "id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
          "source": {
            "banner": "Order-paid"
          }
        },
        "order": {
          "id": "ord_0ffc4ccac0d5d28b7a",
          "source_id": "your_own_source_id_20250115-005"
        }
      },
      "created_at": "2025-01-15T14:00:02.586Z"
    }
  ],
  "has_more": true,
  "more_starting_after": "lopp_0ffd9661bd5207eb0a"
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
campaignId
string
required

Unique campaign ID.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Query Parameters

​
limit
integer

Limit the number of the pending point entries that the API returns in the response.

Required range: 1 <= x <= 100
​
order
enum<string>

Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.

Available options:
id,
-id
​
starting_after_id
string

A cursor for pagination. It retrieves the results starting after a result with the given ID.

Response

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

Response body schema for GET /loyalties/{campaignId}/pending-points. Lists pending point entries.

​
object
enum<string>
default:list
required

The type of the object represented by JSON.

Available options:
list
​
data_ref
enum<string>
default:data
required

Identifies the name of the attribute that contains the array of pending point objects.

Available options:
data
​
data
Loyalty Pending Point Entry · object[]
required

A dictionary that contains an array of pending point entries. Each entry in the array is a separate pending point object.

​
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.

⌘I