How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talon.One Loyalty API

Represents loyalty programs or concepts related to them.Loyalty programs can be _profile-based_ or _card-based_, depending on whether loyalty points are linkedto [customer profiles](https://docs.talon.one/docs/product/applications/displaying-customer-profiles) or [loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview).See [the Product docs](https://docs.talon.one/docs/product/loyalty-programs/overview) for more information.

Talon.One Loyalty API is one of 42 APIs that Talon.One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Loyalty. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 24 operations across 24 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://yourbaseurl.talon.one.

24 operations 24 paths 33 schemas 16 GET6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://yourbaseurl.talon.one
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Talon.One Loyalty API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (api_key_v1). An API key is passed in the header as Authorization (manager_auth). An API key is passed in the header as Authorization (management_key).

  • api_key_v1 — To authenticate with the Integration API, generate an API key in the Campaign Manager and prefix it with ApiKey-v1. To generate an API key: 1. Sign in to the C…
  • manager_auth — This authentication scheme relies on a bearer token that you can use to access all the endpoints of the Management API. To create the token: 1. Get a bearer to…
  • management_key — The API key authentication gives you access to the endpoints selected by the admin who created the key. Using an API key is the recommended authentication meth…

Paths & Operations 24

Across 24 paths, the API surfaces 24 operations — 16 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Loyalty 24

Represents loyalty programs or concepts related to them. Loyalty programs can be profile-based or card-based, depending on whether loyalty points are linked to [customer profiles]…

GET
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances
Get customer's loyalty balances
getLoyaltyBalances 6 params → 200400401404
GET
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions
List customer's loyalty transactions
getLoyaltyProgramProfileTransactions 11 params → 200400401404
POST
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/delete_transactions
Delete customer's transactions from loyalty ledgers
deleteLoyaltyTransactionsFromLedgers 2 params body → 204400401404
POST
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/join
Join customer profile to loyalty program
joinLoyaltyProgram 2 params → 200400401404
GET
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points
List customer's unused loyalty points
getLoyaltyProgramProfilePoints 9 params → 200400401404
POST
/v1/loyalty_programs/{loyaltyProgramId}/activate_points
Activate loyalty points
activateLoyaltyPoints 1 param body → 200400401404
GET
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balances
Get customer's loyalty balances (Management API)
getLoyaltyLedgerBalances 6 params → 200400401404
GET
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactions
List customer's loyalty transactions (Management API)
getLoyaltyProgramProfileLedgerTransactions 11 params → 200400401404
GET
/v1/loyalty_programs
List loyalty programs
getLoyaltyPrograms → 200
GET
/v1/loyalty_programs/{loyaltyProgramId}
Get loyalty program
getLoyaltyProgram 1 param → 200
GET
/v1/loyalty_programs/{loyaltyProgramId}/dashboard
Get statistics for loyalty dashboard
getDashboardStatistics 4 params → 200
POST
/v1/loyalty_programs/{loyaltyProgramId}/import_points
Import loyalty points
importLoyaltyPoints 2 params body → 200
POST
/v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers
Import customers into loyalty tiers
importLoyaltyCustomersTiers 1 param body → 200400401404
POST
/v1/loyalty_programs/{loyaltyProgramId}/import_join_dates
Import join dates for a loyalty program
importLoyaltyJoinDates 1 param body → 200400401404
GET
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}deprecated
Get customer's full loyalty ledger
getLoyaltyPoints 2 params → 200
PUT
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points
Add points to customer profile
addLoyaltyPoints 2 params body → 204400401404
PUT
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points
Deduct points from customer profile
removeLoyaltyPoints 2 params body → 204400401404
GET
/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log
Export customer's transaction logs
exportLoyaltyLedger 5 params → 200
GET
/v1/loyalty_programs/{loyaltyProgramId}/export_join_dates
Export customers' loyalty program join dates
exportLoyaltyJoinDates 1 param → 200400401
GET
/v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers
Export customers' tier data
exportCustomersTiers 3 params → 200
GET
/v1/loyalty_programs/{loyaltyProgramId}/statisticsdeprecated
Get loyalty program statistics
getLoyaltyStatistics 1 param → 200
GET
/v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances
Export customer loyalty balances
exportLoyaltyBalances 3 params → 200400401
GET
/v1/loyalty_programs/{loyaltyProgramId}/export_customer_balancedeprecated
Export customer loyalty balance to CSV
exportLoyaltyBalance 3 params → 200400401
GET
/v1/loyalty_programs/{loyaltyProgramId}/transactions
List loyalty program transactions
getLoyaltyProgramTransactions 10 params → 200400401404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are LoyaltyProgramTransaction (21 properties), LedgerTransactionLogEntryIntegrationAPI (16 properties), LoyaltyLedgerEntry (16 properties), BaseLoyaltyProgram (15 properties). Each schema is shown below with its type and property counts.

Tier
object
5 properties 2 required
LedgerPointsEntryIntegrationAPI
object
Loyalty profile points with start and expiry dates.
11 properties 9 required
ErrorResponseWithStatus
object
3 properties
LoyaltyBalance
object
Point balance of a ledger in the Loyalty Program.
5 properties
APIError
object
3 properties 2 required
LoyaltyBalanceWithTier
ProjectedTier
object
3 properties 1 required
LedgerTransactionLogEntryIntegrationAPI
object
Log entry for a given loyalty profile transaction.
16 properties 10 required
ActivateLoyaltyPointsResponse
object
1 property
LoyaltyLedgerEntry
object
A single row of the ledger, describing one addition or deduction.
16 properties 6 required
LoyaltyBalancesWithTiers
object
List of loyalty balances for a ledger and its subledgers.
2 properties
ErrorSource
object
The source of the current error, exactly one of pointer, parameter or line will be defined.
4 properties
ActivateLoyaltyPoints
object
Activate loyalty points
2 properties
LoyaltyLedgerEntryFlags
object
A map of flags providing additional details about the entry.
1 property
DeleteLoyaltyTransactionsRequest
object
Request to delete transactions based on the specified scope.
2 properties 1 required
BaseLoyaltyProgram
object
15 properties
AccountEntity
object
1 property 1 required
LoyaltyDashboardData
object
Datapoint for the graphs and cards on a loyalty program dashboard.
10 properties 10 required
Entity
object
2 properties 2 required
UserEntity
object
1 property 1 required
LoyaltyTier
LoyaltyDashboardPointsBreakdown
object
2 properties 2 required
NewLoyaltyTier
object
A tier in a loyalty program.
2 properties 2 required
LoyaltyProgramTransaction
object
21 properties 10 required
LoyaltyProgramEntity
object
3 properties 1 required
CodeGeneratorSettings
object
2 properties 2 required
LoyaltyCardIdentifier
string
The identifier of the loyalty card, which must match the regular expression ^[A-Za-z0-9.%+@-]+$.
AddLoyaltyPoints
object
Points to add.
8 properties 1 required
Import
LoyaltySubLedger
object
Ledger of Balance in Loyalty Program for a Customer.
12 properties 6 required
DeductLoyaltyPoints
object
Points to deduct.
4 properties 1 required
LoyaltyProgram
LoyaltyLedger
object
Ledger of Balance in Loyalty Program for a Customer.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talon-one-loyalty-api-openapi.yml Raw ↑

Other APIs Talon.One publishes across the network.

Talon.One Accounts and users API
Talon.One Achievements API
Talon.One Additional costs API
Talon.One Analytics API
Talon.One Applications API
Talon.One Attributes API
Talon.One Audiences API
Talon.One Braze API
Talon.One Campaign access groups API
Talon.One Campaign notifications API
Talon.One Campaign templates API
Talon.One Campaigns API
Where this information came from

This is an independent, third-party profile of Talon.One Loyalty API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.