OpenAPI (Swagger) Specifications
Download OpenAPI specifications for use with API development tools like Postman, Insomnia, and more.
Machine-Readable API Specifications
These OpenAPI (formerly Swagger) specifications can be imported into various API development tools for testing, documentation, and code generation.
Available Specifications
| API Name | Description | Format | Actions |
|---|---|---|---|
Main Performance Hub API | Complete access to all platform features including organisations, users, facilities, and analytics | JSON | Download |
Store Front API | Build custom e-commerce experiences for selling products, memberships, and services | JSON | Download |
Universal API | REST interface to all Performance Hub services | JSON | Download |
How to Import Specifications
Staying Updated
The OpenAPI specifications are automatically updated with each deployment. To ensure you're using the latest version:
- Re-import the specification periodically in your tools
- Use the direct URLs rather than downloading local copies
- Check the
info.versionfield in the specification for the current version