Guide: Reading from GET · Conditions →

GET /points response

OpenAPI reference: GetAListOfScoreCampaigns — GET https://streaming.loyal.guru/points.

Typical use cases for integrations:

• List active points/wallet campaigns (GET /points).
• Filter by event type: ?when=manual returns only direct assignment campaigns (see Campaigns API).
• Catalog by customer, country, or tier per query parameters when the API exposes them on the list.

List behavior (typical):

• Only active campaigns (active: true) valid per available_from / available_to.
• Pagination with starting_after / next_token_starts_after when the response includes it.

On this page

• Query parameters
• Response wrapper
• Rule fields in the response
• Metadata per item in data[]
• Activation and expiration (balance lifecycle)
• API integration on ticket

---

Query parameters

Parameter	Usage
when	Filter by campaign event (e.g. manual for direct assignment).
customer_id / customer_code	Customer catalog or eligibility when the endpoint supports it.
countries	Filter by registration country or scope.
tier_id	Campaigns linked to a tier.
starting_after	Pagination: token from the previous page.

See the current OpenAPI docs for the full filter list on GET /points.

Response wrapper

Field	Description
data	Array of campaign objects.
next_token_starts_after	Token for the next page (starting_after). Absent on the last page.

Rule fields in the response

GET /points (list) and GET /points/{id} (detail) use the same names on the campaign object:

Response field	Typical type	Content after parsing
rule_conditions	string JSON	conditions.and[] / conditions.or[] (or flat format on POST)
rule_application	string JSON	application.and[] (internal key application)
rule_effects	string JSON	type, value, distribution, limits, rule_group, …

Victory frequency and budget: once, once_limit, budget_value, budget_period — see Limits.

Internal structure vs field name: the API field is rule_application, but inside parsed JSON the root is usually application.and[].

Metadata per item in data[]

Block	Fields	Integration use
Identity	id, name, description	Campaign ID and copy.
Event	when	after_create_activity (cart), after_create_custom_entity (custom event), configured trigger slug, or manual (direct assignment)
Currency / mode	currency, accrual_mode (if present)	Currency of monetary rule_effects.value; points vs money for presentation. Requires that currency’s score_exchange to convert to points — see Effects.
Validity	active, available_from, available_to, recurrence_type, recurrence_days	Whether the campaign applies today.
Audience	select_customers, customer_registration_countries, tiers[]	loyalty or targeted only — all_customers does not apply to points (identified customer required). There is no semantic equivalent to discount campaign_audience=all_customers in points lists.
Activation	activation_period_type, activation_delay	When accrued balance becomes available.
Expiration	expiration_period_type, availability_duration	When accrued balance expires.
Victory limits	once, once_limit, budget_value, budget_period	See Limits.
Category	category (if present)	Rule classification in Owner App.

Activation and expiration (balance lifecycle)

After accrual, the customer may see balance in different states:

Concept	GET fields (typical)	Integration
Activation	activation_period_type, activation_delay	Delay until balance is usable (e.g. N days after the ticket).
Expiration	expiration_period_type, availability_duration	Fixed window or period when balance expires.

Product detail: Points Campaigns and expiration docs for your KB version.

API integration on ticket

When creating or simulating a ticket (POST /activities or POST /activities/simulate), the apply_points flag on the payload controls whether that transaction evaluates points campaigns (default is usually true). See API integration.

Parsing: rule_conditions, rule_application, and rule_effects usually arrive as JSON strings. Deserialize before reading clauses.

---

Next: Conditions (rule_conditions)