canonical: https://jentic.com/apis/toasttab.com/toasttab

# Toasttab Toast Loyalty Integration API

This API specification describes the interface that the Toast POS system will call when it processes loyalty transactions. Implement this REST API to allow the Toast POS system to process loyalty transactions using a loyalty provider that it does not currently support. The API exposes 1 endpoints.

## For AI agents

Programmatically provide information on a loyalty transaction
. Covers 1 operations.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Provide information on a loyalty transaction
- Manage payments data programmatically
- Integrate Toast Loyalty Integration API into automated workflows
- Query and filter Toast Loyalty Integration API records by parameters
- Monitor Toast Loyalty Integration API operational status and events

## Use cases

### Payments Operations

Use the Toast Loyalty Integration API to perform payments operations programmatically. The API provides 1 endpoints covering core functionality including provide information on a loyalty transaction
.

Example prompt: Call POST /yourendpointname to provide information on a loyalty transaction

### Data Retrieval and Monitoring

Query Toast Loyalty Integration API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Toast Loyalty Integration API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Toast Loyalty Integration API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'provide information on a loyalty transaction
', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/yourendpointname` | Provide information on a loyalty transaction |

## Key resources

- **Yourendpointname** — Operations for yourendpointname

## Why Jentic

- **Setup:** Wiring the Toast Loyalty Integration API by hand means resolving your Toast API server host, shaping the single loyalty endpoint's payload, and handling retries yourself. Through Jentic you install once, import Toast Loyalty Integration from the API Directory, and your agent calls it.
- **Permission scoping:** This Toast Loyalty spec exposes a single operation addressed by the request body rather than a resource id in the URL path, so scope the agent to that one operation. You choose whether it is included, and nothing beyond it becomes available.
- **Credential handling:** This Toast spec declares no credential, so there is nothing for Jentic One to store; any credential your integration requires is held encrypted by your own instance and injected at execution time, never in the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'post a loyalty transaction', and Jentic returns the matching Toast Loyalty operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Toast Loyalty Integration API use?

The Toast Loyalty Integration API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I provide information on a loyalty transaction
 with the Toast Loyalty Integration API?

Yes. Use the POST /yourendpointname endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Toast Loyalty Integration API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I provide information on a loyalty transaction
 through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'provide information on a loyalty transaction
'. Jentic returns the matching Toast Loyalty Integration API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Toast Loyalty Integration API have?

The Toast Loyalty Integration API exposes 1 endpoints covering yourendpointname operations.

### Can I limit what my agent is allowed to do with the Toast Loyalty Integration API?

Yes. Because Jentic One is self-hosted, your own rules decide which operations and credentials your agent may use. This API exposes a single loyalty-transaction operation (the POST call addressed by the request body rather than a resource id in the path), so you choose whether that one operation is included, and nothing beyond it becomes available to the agent. You keep control of exactly what the agent can call.