canonical: https://jentic.com/apis/clienttoolbox.com/loyalty-gator

# Clienttoolbox Loyalty Gator API

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.

## For AI agents

Run a customer loyalty program end to end: enrol customers, award and redeem points, manage cards, run campaigns, and pull dashboard metrics.

## Scope

Does not handle payment processing, inventory management, or full CRM workflows - use for loyalty program operations only.

## Capabilities

- 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

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

Example prompt: 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: 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

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

## Key resources

- **Account** — Program-level info and dashboard metrics.
- **Customers** — Member directory with create, search, find, info, balance, validate, delete, and batch operations.
- **Transactions** — Point-awarding and redemption operations against customer accounts.
- **Campaigns** — Targeted offer and promotion campaigns.
- **Cards** — Card number generation and replacement endpoints.
- **Custom Fields** — Custom data fields attached to customer or transaction records.
- **Reports** — Program reporting and analytics endpoints.
- **Email Templates** — Templated communications used by campaigns.

## Why Jentic

- **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 handling:** 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.
- **Discovery method:** 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

- **Loyalty Gator API** — Same product, modelled as a single dispatch endpoint for catalogue indexing.
- **LoyaltyLion API** — Loyalty platform focused on Shopify and e-commerce stores.
- **Yotpo API** — Reviews, loyalty, and SMS for e-commerce brands.
- **Talon.One API** — Promotion and loyalty rules engine for marketing teams.

## FAQ

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