> ## Documentation Index
> Fetch the complete documentation index at: https://developers.perkstar.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# API availability

> See which Perkstar resources are stable public contracts and which workflows are not yet partner-ready.

This matrix is the honest boundary of the public v1 API. A dashboard feature or
internal provider adapter is not automatically a supported public resource.

| Capability           | Public status         | Supported path                                                                                                         |
| -------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| Customers            | Available             | List, retrieve, create/upsert, update, and anonymise through `/customers`                                              |
| Enrolments           | Available             | List, retrieve, create, and update status through `/enrollments`                                                       |
| Transactions         | Available             | List and post loyalty ledger entries through `/transactions`                                                           |
| Loyalty cards        | Read-only             | List and retrieve card configuration through `/cards`                                                                  |
| Locations            | Read-only             | List mapped business locations through `/locations`                                                                    |
| Wallet pushes        | Write-only            | Send to an enrolment through `/pushes`                                                                                 |
| Outbound webhooks    | Available             | Configure endpoints through `/webhooks`; receive the [event catalogue](/reference/webhook-events)                      |
| POS/ERP loyalty      | Available             | Use `/marketplace/ping`, `/marketplace/accrue`, `/marketplace/enroll`, and `/marketplace/reverse`                      |
| Rewards and vouchers | Event/workflow access | Observe earning and redemption through enrolments, transactions, and webhooks; no first-class public CRUD resource yet |
| Tiers and benefits   | Event/read context    | Card and event context is available; tier and benefit management is not a public contract yet                          |
| Orders               | Partner-owned         | Send stable external transaction IDs and amounts; Perkstar does not expose a generic order resource                    |
| Coupons              | Redemption events     | `coupon.redeemed` is public; coupon catalogue and redemption APIs are not yet public                                   |

## What partner-ready means

Perkstar publishes a resource only after it has:

* an organisation and scope boundary;
* stable identifiers and idempotency rules;
* documented validation, errors, and rate limits;
* test-mode behaviour that cannot alter live data;
* OpenAPI, TypeScript, Python, and Postman parity; and
* webhook or reconciliation behaviour where eventual consistency matters.

Until those conditions are met, use the documented public workflow rather
than calling dashboard actions or internal routes. Internal endpoints can
change without notice and are not covered by the API versioning policy.

## Designing future functionality

For reward, voucher, tier, benefit, coupon, or order requirements that the
matrix does not cover, contact
[support@perkstar.co.uk](mailto:support@perkstar.co.uk) with the provider,
merchant journey, required writes, and reconciliation model. This lets
Perkstar promote a complete contract instead of exposing a fragile partial
endpoint.


## Related topics

- [Integration gallery](/integrations/index.md)
- [API status](/support/status.md)
- [Run the API in Postman](/tools/postman.md)
- [Auth check + org context](/api-reference/marketplace/auth-check-+-org-context.md)
- [Security, privacy, and data handling](/fundamentals/security-privacy.md)