Skip to main content

API Introduction

Introduction to CIM's API

Howie avatar
Written by Howie
Updated over a month ago

What does the CIM API do?

The CIM API lets you directly access the data captured and normalised by our platform including energy metrics, alerts and actions, sensor readings and more–all without the need for navigating the interface. It can be used to automate data transfers out of the platform.

Who should use the CIM API?

The CIM API is intended for developers and data analysts who have knowledge of programming languages who need to integrate our data with other tools or platforms.

How does the CIM API work?

The CIM API is organised around REST and uses OAuth 2.0 for secure access. Our developer portal and example use cases can be found here:

API documentation

Use the links below to access the Swagger API documentation for each endpoint.

Endpoint

Swagger docs

What it covers

Core

Primary platform data and operations.

Tickets

Alert and action tickets, related activity, and metrics.

Notifications

Event notifications via webhook subscriptions .

Did this answer your question?