REST APIs

Overview

REST stands for Representational state transfer. REST APIs are web service APIs that adhere to the constraints of REST architecture. Learn more about REST.

LeanIX offers a wide range of REST APIs. These APIs provide access to various resources, such as the Meta Model, Workspace settings, Users, Metrics, Surveys, and more.

Use REST APIs to integrate with systems that support RESTful interactions.

📘
The endpoint base URL is different for different customers. It depends on the domain of your Workspace. In our documentation, the base URL appears as https://{SUBDOMAIN}.leanix.net. Learn more.

To work with your Fact Sheets and related data, use the GraphQL API.

Available APIs

To get an overview of our REST APIs and learn when to use each API, see REST APIs Overview.

Authentication

To learn how to authenticate to REST APIs, see Authentication to LeanIX APIs.

OpenAPI Explorer

The OpenAPI Explorer allows you to discover LeanIX REST APIs and try out requests right in your browser.

📘
Because there are multiple instances of the LeanIX app, the link to the OpenAPI Explorer differs for different customers. Navigate to the OpenAPI Explorer from your Workspace.

To navigate to the OpenAPI Explorer from your Workspace:

On the user menu, select Administration. Under Discovery & Integrations, select Developer Tools, and then select Browse API.

or
On the user menu, select About LeanIX, and then select Browse API.

To browse available APIs in the OpenAPI Explorer, use the menu in the upper-right corner.

Browse available REST APIs in the OpenAPI Explorer

Use Cases

LeanIX REST APIs provide access to various resources. You can use them to import and export data, set up integrations, and automate workflows for your organization.

Here are some example use cases: