Talon.One

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 linked to [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.

GitHub OpenAPI
Business capability
Loyalty & Retention Management BC-420.40

Operations 24

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances Get a customer's loyalty balances in real time · Get customer's loyalty balances #
Ask an LLM
“How many active and pending points does this shopper have right now, from my storefront integration?”
“Can the real-time balance lookup also tell me the customer's current and projected tier?”
Tell an agent
Show the real-time loyalty balance for customer {integrationId} in program {loyaltyProgramId}.
Get customer {integrationId}'s Integration API balance in program {loyaltyProgramId} as of {endDate}, including tier details.
GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions List a customer's loyalty transactions in real time · List customer's loyalty transactions #
Ask an LLM
“Where can my app show a shopper their recent points earned and spent, straight from the Integration API?”
“Which loyalty transactions did a customer make between two dates in a specific subledger?”
Tell an agent
List the latest Integration API loyalty transactions for customer {integrationId} in program {loyaltyProgramId}.
Show customer {integrationId}'s real-time points transactions in program {loyaltyProgramId} from {startDate} to {endDate}.
POST /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/delete_transactions Delete a customer's loyalty transactions · Delete customer's transactions from loyalty ledgers #
Ask an LLM
“How do I wipe a customer's loyalty transaction history across every ledger in a program?”
“Can I erase a shopper's points transactions from just one subledger instead of all of them?”
Tell an agent destructive · confirm first
Delete all loyalty transactions for customer {integrationId} in program {loyaltyProgramId} with scope {scope}.
Remove customer {integrationId}'s transactions from subledgers {subledgerIds} of loyalty program {loyaltyProgramId}, scope {scope}.
POST /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/join Enroll a customer in a loyalty program · Join customer profile to loyalty program #
Ask an LLM
“How do I sign a customer up for my profile-based loyalty program?”
“Will enrolling a shopper in a loyalty program create their customer profile if it doesn't exist yet?”
Tell an agent
Enroll customer {integrationId} in loyalty program {loyaltyProgramId}.
Join profile {integrationId} to loyalty program {loyaltyProgramId}, creating the profile if needed.
GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points List a customer's unused loyalty points · List customer's unused loyalty points #
Ask an LLM
“Which of a customer's unused points are active, pending or expiring soon?”
“Can I list the individual unspent point batches on a customer profile rather than just a total?”
Tell an agent
List the unused points batches for customer {integrationId} in program {loyaltyProgramId}.
Show customer {integrationId}'s unspent points with status {status} in loyalty program {loyaltyProgramId}.
POST /v1/loyalty_programs/{loyaltyProgramId}/activate_points Activate pending loyalty points · Activate loyalty points #
Ask an LLM
“How do I turn pending points into spendable points once an order ships?”
“Can I activate all the points a customer earned in one session at once?”
Tell an agent
Activate the pending points earned in session {sessionId} in loyalty program {loyaltyProgramId}.
Activate pending points from transactions {transactionUUIDs} in program {loyaltyProgramId}.
GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balances Get a customer's loyalty balances for back-office use · Get customer's loyalty balances (Management API) #
Ask an LLM
“Is there a Management API version of the customer points balance lookup for back-office tools?”
“Can an admin dashboard pull a customer's ledger balances and tier info outside the real-time integration?”
Tell an agent
Using the Management API, get the ledger balances of customer {integrationId} in program {loyaltyProgramId}.
Pull back-office balances for customer {integrationId} in loyalty program {loyaltyProgramId} for subledger {subledgerId}.
GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactions List a customer's loyalty transactions for back-office use · List customer's loyalty transactions (Management API) #
Ask an LLM
“Can an admin tool list a customer's points transactions through the Management API instead of the Integration API?”
“For a support agent, is there a back-office way to filter a customer's transactions by main ledger or subledger?”
Tell an agent
Via the Management API, list ledger transactions for customer {integrationId} in program {loyaltyProgramId}.
Show back-office transaction logs for customer {integrationId} in program {loyaltyProgramId} of type {loyaltyTransactionType}.
GET /v1/loyalty_programs List loyalty programs · List loyalty programs #
Ask an LLM
“What loyalty programs exist in my Talon.One account?”
“Where can I find the IDs of all my loyalty programs?”
Tell an agent
List all loyalty programs in my account.
Show me every loyalty program and its ID.
GET /v1/loyalty_programs/{loyaltyProgramId} Get a loyalty program's details · Get loyalty program #
Ask an LLM
“How is a particular loyalty program configured?”
“Can I look up one loyalty program's settings by its ID?”
Tell an agent
Get the configuration of loyalty program {loyaltyProgramId}.
Show details for loyalty program {loyaltyProgramId}.
GET /v1/loyalty_programs/{loyaltyProgramId}/dashboard Get loyalty dashboard statistics for a date range · Get statistics for loyalty dashboard #
Ask an LLM
“How many points were active, pending, spent and expired in my loyalty program last month?”
“Does the loyalty dashboard data include today's activity?”
Tell an agent
Get dashboard statistics for loyalty program {loyaltyProgramId} from {rangeStart} to {rangeEnd}.
Show points activity for subledger {subledgerId} of program {loyaltyProgramId} between {rangeStart} and {rangeEnd}.
POST /v1/loyalty_programs/{loyaltyProgramId}/import_points Import loyalty points from a CSV file · Import loyalty points #
Ask an LLM
“How do I bulk-load points balances from my old loyalty system with a CSV?”
“Can I import points in bulk without sending customers a notification?”
Tell an agent
Import the points CSV {upFile} into loyalty program {loyaltyProgramId}.
Bulk-upload points file {upFile} to program {loyaltyProgramId} with notifications set to {notificationsEnabled}.
POST /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers Assign customers to loyalty tiers from a CSV · Import customers into loyalty tiers #
Ask an LLM
“Can I move existing customers into specific tiers in bulk using a spreadsheet?”
“Which loyalty programs support importing customer tier assignments?”
Tell an agent
Import the customer tier assignments in {upFile} into loyalty program {loyaltyProgramId}.
Upload tier CSV {upFile} to place customers in tiers of program {loyaltyProgramId}.
POST /v1/loyalty_programs/{loyaltyProgramId}/import_join_dates Import customers' loyalty join dates from a CSV · Import join dates for a loyalty program #
Ask an LLM
“How do I preserve members' original sign-up dates when migrating a loyalty program?”
“Can I set the join date for many customer profiles at once?”
Tell an agent
Import join dates from {upFile} into loyalty program {loyaltyProgramId}.
Upload the member join-date CSV {upFile} for program {loyaltyProgramId}.
GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} Get a customer's full loyalty ledger · Get customer's full loyalty ledger #
Ask an LLM
“Can I see a customer's complete points ledger, not just the balance?”
“What does a member's entire loyalty ledger look like in one program?”
Tell an agent
Get the full loyalty ledger for customer {integrationId} in program {loyaltyProgramId}.
Show me every ledger entry customer {integrationId} has in loyalty program {loyaltyProgramId}.
PUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points Add loyalty points to a customer profile · Add points to customer profile #
Ask an LLM
“How do I give a customer bonus points as a goodwill gesture?”
“Can manually added points start as pending or expire after a set duration?”
Tell an agent
Add {points} points to customer {integrationId} in loyalty program {loyaltyProgramId}.
Credit customer {integrationId} with {points} points in program {loyaltyProgramId}, valid until {validUntil}, reason {name}.
PUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points Deduct loyalty points from a customer profile · Deduct points from customer profile #
Ask an LLM
“How do I take points back from a customer's profile after a return?”
“Can I deduct pending points, or only active ones?”
Tell an agent
Deduct {points} points from customer {integrationId} in loyalty program {loyaltyProgramId}.
Remove {points} active points from profile {integrationId} in program {loyaltyProgramId} with reason {name}.
GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log Export a customer's loyalty transactions to CSV · Export customer's transaction logs #
Ask an LLM
“Can I download one customer's points history as a CSV file?”
“How do I export a single member's loyalty transaction log for a date range?”
Tell an agent
Export customer {integrationId}'s loyalty log in program {loyaltyProgramId} from {rangeStart} to {rangeEnd} as CSV.
Download customer {integrationId}'s points ledger CSV for program {loyaltyProgramId} between {rangeStart} and {rangeEnd} using date format {dateFormat}.
GET /v1/loyalty_programs/{loyaltyProgramId}/export_join_dates Export customers' loyalty join dates to CSV · Export customers' loyalty program join dates #
Ask an LLM
“When did each member join my loyalty program?”
“Can I download a CSV of every customer's enrollment date?”
Tell an agent
Export the join dates of all members of loyalty program {loyaltyProgramId}.
Download a CSV of when each customer joined program {loyaltyProgramId}.
GET /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers Export customers' loyalty tier data to CSV · Export customers' tier data #
Ask an LLM
“Which tier is each of my loyalty members in right now?”
“Can I export tier data only for certain tier names or subledgers?”
Tell an agent
Export the customer tier data for loyalty program {loyaltyProgramId}.
Download a CSV of customers in tiers {tierNames} of program {loyaltyProgramId}.
GET /v1/loyalty_programs/{loyaltyProgramId}/statistics Get loyalty program statistics (deprecated) · Get loyalty program statistics #
Ask an LLM
“Is the older loyalty program statistics endpoint still available even though it's deprecated?”
“What overall totals did the legacy loyalty statistics call return for a program?”
Tell an agent
Get the legacy statistics for loyalty program {loyaltyProgramId} using the deprecated endpoint.
Call the deprecated loyalty statistics endpoint for program {loyaltyProgramId}.
GET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances Export all customers' loyalty balances to CSV · Export customer loyalty balances #
Ask an LLM
“How can I get a spreadsheet of every member's points balance?”
“Can I export customer balances as they stood on a specific end date?”
Tell an agent
Export every customer's balance in loyalty program {loyaltyProgramId} to CSV.
Export customer balances for program {loyaltyProgramId} as of {endDate}.
GET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance Export customer loyalty balances (legacy endpoint) · Export customer loyalty balance to CSV #
Ask an LLM
“Does the older singular export_customer_balance endpoint still produce a balances CSV?”
“What does the legacy customer-balance export return compared with its replacement?”
Tell an agent
Use the legacy single-balance export to download balances for loyalty program {loyaltyProgramId}.
Run the older export_customer_balance download for program {loyaltyProgramId} as of {endDate}.
GET /v1/loyalty_programs/{loyaltyProgramId}/transactions List all transactions in a loyalty program · List loyalty program transactions #
Ask an LLM
“What points transactions happened across my whole loyalty program this week?”
“Are manual and imported transactions included when I list a program's activity?”
Tell an agent
List recent transactions across all members of loyalty program {loyaltyProgramId}.
Show program-wide {loyaltyTransactionType} transactions in program {loyaltyProgramId} since {startDate}.

Documentation

📖
APIReference
https://docs.talon.one/integration-api
📖
Documentation
https://docs.talon.one/docs/dev/integration-api/overview
📖
GettingStarted
https://docs.talon.one/docs/dev/quickstart
📖
APIReference
https://docs.talon.one/management-api
📖
Documentation
https://docs.talon.one/docs/dev/management-api/overview
📖
APIReference
https://docs.talon.one/third-party-api
📖
Documentation
https://docs.talon.one/docs/dev/technology-partners/overview
📖
Documentation
https://docs.talon.one/docs/dev/technology-partners/shopify/integrate-with-shopify
📖
Documentation
https://docs.talon.one/docs/dev/get-started/webhooks
📖
APIReference
https://docs.talon.one/outbound-notifications

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/openapi/talon-one-loyalty-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/collections/talon-one.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/collections/talon-one.opencollection.json
🔗
Postman
https://www.postman.com/talonone-rnd/workspace/talon-one/overview
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/data-model/talon-one-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/asyncapi/talon-one-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/talon-one:talon-one-loyalty-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

talon-one-loyalty-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Talon One Loyalty API
  version: ''
  description: 'Operations tagged Loyalty across 2 of this provider''s published API definitions: talon-one-integration-api-openapi.yml, talon-one-management-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://yourbaseurl.talon.one
tags:


# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/talon-one/refs/heads/main/openapi/talon-one-loyalty-api-openapi.yml