https://github.com/intercom/intercom-openapi

An OpenAPI description for Intercom's REST API
https://github.com/intercom/intercom-openapi

intercom open-api

Last synced: 2 months ago
JSON representation

An OpenAPI description for Intercom's REST API

• Host: GitHub
• URL: https://github.com/intercom/intercom-openapi
• Owner: intercom
• License: mit
• Created: 2022-12-15T11:01:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T16:00:14.000Z (8 months ago)
• Last Synced: 2024-05-22T17:26:16.437Z (8 months ago)
• Topics: intercom, open-api
• Language: JavaScript
• Homepage:
• Size: 3.56 MB
• Stars: 9
• Watchers: 48
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Intercom's REST API OpenAPI Description

This repository contains [OpenAPI](https://www.openapis.org/) descriptions for [Intercom's REST API](https://developers.intercom.com/intercom-api-reference/reference/welcome). It covers API versions 2.7 and higher.

## What is OpenAPI?

From the [OpenAPI Specification](https://github.com/OAI/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](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.](https://github.com/intercom/Intercom-OpenAPI/issues/new?template=schema-inaccuracy.md)