Skip to main content
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.

​
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 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 galleryAPI statusRun the API in PostmanAuth check + org contextSecurity, privacy, and data handling