intercom / Intercom-OpenAPI

An OpenAPI description for Intercom's REST API
MIT License
12 stars 10 forks source link
intercom open-api

Intercom's REST API OpenAPI Description

This repository contains OpenAPI descriptions for Intercom's REST API. It covers API versions 2.7 and higher.

What is OpenAPI?

From the OpenAPI Specification:

The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.

Contributing

Because this description is automatically generated from our internal codebase, we don't currently accept pull requests that directly modify the description. See CONTRIBUTING.md for more details.

If you've identified a mismatch between the Intercom API's behavior and these descriptions, or found an issue with the format of a schema, please open an issue.