Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Heroku Collaborators API

App collaborator management

Heroku Collaborators API is one of 14 APIs that Heroku publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Collaborators. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a getting-started guide, and authentication docs.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 3.

Requests are made against a single base URL, https://api.heroku.com.

3 operations 2 paths 1 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3
Base URL
https://api.heroku.com
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Heroku Collaborators API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Heroku API key or OAuth token

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Collaborators 3

App collaborator management

GET
/apps/{app_id_or_name}/collaborators
List collaborators
listCollaborators 1 param → 200
POST
/apps/{app_id_or_name}/collaborators
Create a collaborator
createCollaborator 1 param body → 201
DELETE
/apps/{app_id_or_name}/collaborators/{collaborator_email_or_id}
Delete a collaborator
deleteCollaborator 2 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Collaborator (7 properties). Each schema is shown below with its type and property counts.

Collaborator
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heroku-collaborators-api-openapi.yml Raw ↑

Other APIs Heroku publishes across the network.

Heroku Account API
Heroku Add-ons API
Heroku Apps API
Heroku Builds API
Heroku Config Vars API
Heroku Domains API
Heroku Dynos API
Heroku Formation API
Heroku Log Sessions API
Heroku Pipelines API
Heroku Regions API
Heroku Releases API