# Heroku Platform API Design Conventions

**Canonical:** https://apis.io/apis/style-guides/heroku/  
**Provider:** API Style Guides — https://apis.io/providers/style-guides/  
**Base URL:** https://api.heroku.com  
**Documentation:** https://devcenter.heroku.com/articles/platform-api-reference

Heroku Platform API Design Conventions is one of 11 APIs that [API Style Guides](https://apis.io/providers/style-guides/) publishes on the [APIs.io](https://apis.io/) network. This API exposes 1 JSON Schema definition. Tagged areas include REST, Heroku, JSON-Schema, and Stability Levels.

Heroku's design conventions for the Platform API, documented in the Platform API Reference and the API Compatibility Policy. Notable for versioned media types (application/vnd.heroku+json; version=3), JSON Schema discovery via /schema, Range-based pagination, stability levels (prototype / development / production), and structured error payloads.

## Machine-readable artifacts (4)

- **StyleGuide** — https://devcenter.heroku.com/articles/platform-api-reference
- **CompatibilityPolicy** — https://devcenter.heroku.com/articles/api-compatibility-policy
- **JSONSchema** — https://api.heroku.com/schema
- **Scope**

## Other API Style Guides APIs (10)

- [Microsoft REST API Guidelines](https://apis.io/apis/style-guides/microsoft/)
- [Google API Improvement Proposals (AIPs)](https://apis.io/apis/style-guides/google-aip/)
- [Zalando RESTful API and Event Guidelines](https://apis.io/apis/style-guides/zalando/)
- [PayPal API Design Guidelines](https://apis.io/apis/style-guides/paypal/)
- [adidas API Guidelines](https://apis.io/apis/style-guides/adidas/)
- [Cisco REST API Design Guide](https://apis.io/apis/style-guides/cisco/)
- [Atlassian REST API Design Guidelines](https://apis.io/apis/style-guides/atlassian/)
- [GitLab API Style Guide](https://apis.io/apis/style-guides/gitlab/)
- [Kubernetes API Conventions](https://apis.io/apis/style-guides/kubernetes/)
- [IETF HTTPAPI Working Group Drafts and RFCs](https://apis.io/apis/style-guides/ietf-httpapi/)

## Tags

REST, Heroku, JSON-Schema, Stability Levels

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/style-guides/heroku/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/style-guides/.