Skip to content

intercom/Intercom-OpenAPI

Intercom REST API OpenAPI Description

This repository contains OpenAPI descriptions for Intercom’s REST API. It defines the HTTP interface used to integrate with Intercom’s customer engagement and support platform.

Supported 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.


About the Intercom API

The Intercom API provides programmatic access to Intercom’s platform, including endpoints for messages, conversations, contacts, companies, and automation.

Using this OpenAPI specification, developers can:

  • Generate SDKs or client libraries using tools such as OpenAPI Generator
  • Explore schemas and models for Intercom’s API objects
  • Build, test, and validate integrations in a consistent and language-agnostic way

Fin by Intercom

The Intercom API can empower Fin.ai, Intercom’s AI assistant for customer support and automation. You can use the API to create and edit the articles that Fin uses when answering customers' questions. The API can also set data like conversation and user attributes to be referenced by Fin Guidance or control the flow of automations like Fin Procedures.

Fin Procedures Define multi-step actions that Fin can execute through the API to handle structured or recurring workflows. Learn more on the Fin Procedures overview or read the Fin Procedures help guide.

Fin Voice Build voice-based customer experiences powered by Fin’s conversational AI. Learn more on the Fin Voice product page or see Fin Voice setup instructions.


Related Resources


Contributing

Because this description is automatically generated from Intercom’s internal codebase, so we do not currently accept direct pull requests that directly modify the specification. 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.


Versioning

This specification tracks the current Intercom API version. Last updated: October 2025.


About Intercom

Intercom is a platform for AI-powered customer communication, combining messaging, automation, and human support to help businesses connect with their customers at scale.

About

An OpenAPI description for Intercom's REST API

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published