Clienttoolbox Loyalty Gator API
Browse all Clienttoolbox APIs66
AI ReadinessAI-Aware (B)66/100
Agent-ready OpenAPI document · curated by JenticMarketingMarketing AutomationapiKey68 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Run a customer loyalty program end to end: enrol customers, award and redeem points, manage cards, run campaigns, and pull dashboard metrics.
Use for: I need to enrol a new customer in the loyalty program, Award loyalty points for a purchase, Search for a customer by email or phone, Get a customer's current points balance and history
Not supported: Does not handle payment processing, inventory management, or full CRM workflows - use for loyalty program operations only.
Jentic publishes the only available OpenAPI specification for Loyalty Gator API, keeping it validated and agent-ready. Loyalty Gator from Client Toolbox is a customer loyalty platform exposing 68 operations across customers, transactions, campaigns, rewards, custom fields, email templates, and reporting. Authentication uses the X-Auth header, and every parameter is sent as POST form-data over HTTPS. The API is suited to retail, hospitality, and service businesses that need to award points, run campaigns, and look up customer balances at the point of sale or inside CRM workflows.
Install Jentic One Beta
Connect the Loyalty Gator API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Loyalty Gator API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fclienttoolbox.com%2Floyalty-gator" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fclienttoolbox.com%2Floyalty-gator" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Loyalty Gator API.
Enrol new loyalty customers and update their profile data
Award points and redeem rewards through transaction endpoints
Search and look up customers by id, card number, or arbitrary fields
Issue replacement loyalty cards and generate new card numbers
Run bulk customer operations through the customer_batch endpoint
Pull dashboard metrics and account info for program reporting
Use Cases
Patterns agents use Loyalty Gator API for, with concrete tasks.
★ Point-of-Sale Loyalty Capture
Retailers can have an agent or POS integration call /customer_find at checkout to identify the shopper, /customer_balance to surface their points, and /transactions endpoints to award or redeem points on the sale. Because the API is form-data based, it slots into legacy POS systems without JSON tooling. End-to-end loyalty capture at the till runs in under a second per transaction.
POST to /customer_find with phone='5551234567', then /customer_balance to get the points total, then /transaction_add with points_to_add=50 for a $50 purchase.
Customer Segmentation and Campaigns
Marketing teams can build a segment by calling /customer_search with field filters, then trigger a campaign via the campaign endpoints to send targeted offers to that group. The agent can also pull /reports endpoints to measure redemption lift after the campaign runs. Programs that previously needed CSV exports and manual list uploads now run end to end through the API.
Search customers with last_visit older than 90 days, create a winback campaign for that segment, and after one week pull the redemption report.
Bulk Customer Migration
Businesses moving from a legacy loyalty platform can use /customer_batch_1.5.php to bulk-load existing members and their balances. The agent pages through the source export, batches records, and posts each batch with retries. A typical 50,000-member migration finishes in an afternoon rather than weeks of manual entry.
Read 50,000 rows from the legacy export, post them to /customer_batch_1.5.php in batches of 500, and write a final report listing any rows the API rejected.
Card Lifecycle Management
Service desks can replace lost cards by calling /customer_card_number to mint a new card, then /card_replace to bind it to the customer and retire the old one. The agent records the change in the support ticket and emails the new card number to the customer, all without a human reissuing through the admin UI.
For customer id 8821, call /customer_card_number to mint a new card and then /card_replace to deactivate the old card and bind the new one.
AI Agent Loyalty Operations via Jentic
Agent builders adding loyalty to a chat or in-app assistant can register Loyalty Gator through Jentic and call any of the 68 operations by intent. Jentic isolates the X-Auth credential, so the agent works against the live program without holding the key. Setup time drops from a day of form-data wiring to a few minutes of search-load-execute.
Search Jentic for 'award loyalty points to a customer', load the /transaction_add schema, and execute with the customer id and points value supplied by the user.
Key Endpoints
68 endpoints — jentic publishes the only available openapi specification for loyalty gator api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/customer
Create or register a customer
POST
/customer_search
Search customers by field
POST
/customer_balance
Get a customer's points balance and history
POST
/customer_card_number
Generate a new card number for a customer
POST
/card_replace
Issue a replacement card
POST
/customer_batch_1.5.php
Bulk customer operations
POST
/dashboard_info
Access dashboard metrics
POST
/customer
Create or register a customer
POST
/customer_search
Search customers by field
POST
/customer_balance
Get a customer's points balance and history
POST
/customer_card_number
Generate a new card number for a customer
POST
/card_replace
Issue a replacement card
POST
/customer_batch_1.5.php
Bulk customer operations
POST
/dashboard_info
Access dashboard metrics
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
L
Loyalty Gator API
- AI-Aware (B)66/100
99
Foundational Compliance63
Developer Experience & Jentic Compatibility47
AI-Readiness & Agent Experience91
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
47
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D+Signals: 4
39%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
91
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
91%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Loyalty Gator API by hand means setting the X-Auth header on every call to api.clienttoolbox.com and mapping the right operation across customers, balances, cards, and batches yourself. Through Jentic you install once, import the Loyalty Gator API from the API Directory, store the access key once, and your agent calls it.
Permission scoping
Loyalty Gator takes customer and card details in the request body of its POST operations, so scope the agent to the operations it needs, such as awarding points and searching customers. You choose which operations are in the allowed set, so card replacement is not callable unless you add it.
Credential isolation
Your Loyalty Gator access key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'award loyalty points' or 'search loyalty customers', and Jentic returns the matching Loyalty Gator operation with its form-field schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Loyalty Gator API through Jentic.
Why is there no official OpenAPI spec for Loyalty Gator API?
Client Toolbox does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Loyalty Gator API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Loyalty Gator API use?
Every request takes the X-Auth header carrying the program's API key, with parameters sent as POST form-data over HTTPS. Through Jentic, the X-Auth value is stored in the vault and never enters the agent's prompt - the agent gets a scoped execution token.
Can I award and redeem points with the Loyalty Gator API?
Yes. The transaction endpoints (under /transaction_add and related paths) accept customer id and points fields, and /customer_balance returns the up-to-date balance and history. An agent can chain these on every checkout.
How do I bulk-import customers with the Loyalty Gator API?
POST batches of records to /customer_batch_1.5.php as form-data. The endpoint is designed for migrations and supports thousands of records per call. Through Jentic, search for 'bulk import loyalty customers' to load the schema.
What are the rate limits for the Loyalty Gator API?
Client Toolbox does not publish explicit rate limits in the spec. SSL is mandatory and limits are enforced per account tier. Build clients to handle 429 responses with exponential backoff and check current quotas with Client Toolbox support.
How do I issue a replacement loyalty card through Jentic?
Run pip install jentic, then chain two calls: /customer_card_number to mint a new card, and /card_replace to bind it to the customer and retire the old one. Jentic loads each operation's form-field schema so the agent can build the body without manual reference to docs.
Can I limit what my agent is allowed to do with the Loyalty Gator API?
Yes. Because you run Jentic One yourself, your own rules decide which of Loyalty Gator's POST operations the agent may call, so you can grant it just what it needs, such as awarding points through the transaction endpoints and looking up members with /customer_search and /customer_balance. Operations you leave out of the allowed set stay off limits, so card replacement via /customer_card_number and /card_replace is not callable unless you add it. Your X-Auth access key is stored once by your own instance and injected only at execution time, so the agent never handles the raw credential.
GET STARTED