API Style Guides

Heroku Platform API Design Conventions

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.

GitHub

Schemas & Data

📊
JSONSchema
https://api.heroku.com/schema

Other Resources

🔗
StyleGuide
https://devcenter.heroku.com/articles/platform-api-reference
🔗
CompatibilityPolicy
https://devcenter.heroku.com/articles/api-compatibility-policy
🔗
Scope

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/heroku"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

API entry from apis.yml

apis.yml Raw ↑ 
aid: style-guides:heroku
name: Heroku Platform API Design Conventions
description: 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.
humanURL: https://devcenter.heroku.com/articles/platform-api-reference
baseURL: https://api.heroku.com
tags:
- REST
- Heroku
- JSON-Schema
- Stability Levels
tags_raw:
- REST
- Heroku
- JSON Schema
- Stability Levels
properties:
- type: StyleGuide
  url: https://devcenter.heroku.com/articles/platform-api-reference
- type: CompatibilityPolicy
  url: https://devcenter.heroku.com/articles/api-compatibility-policy
- type: JSONSchema
  url: https://api.heroku.com/schema
- type: Scope
  data:
    surfaces:
    - REST
    publisher: Heroku (Salesforce)
    license: documentation under Heroku terms
    status: living