The Calven API provides services to allow Calven customers to integrate with their Calven instance.

Getting Started

Start by reading Key Access Levels and then request your API keys.

We recommend reading our Calven data models overview to become familiar with the core aspects of Calven's structure, in particular when interacting with our data warehouse APIs.

Using the APIs

The Calven API supports the following operations:

Sending presence events

Sending occupancy events

Sending time off updates

Sending org hierarchy information

Updating access credentials for users

Retrieving Calven data for your data warehouse

Handling Errors

Calven uses conventional HTTP response codes to indicate the success or failure of an API request:

Codes in the 2xx range indicate success.

Codes in the 4xx range indicate a problem with the request, such as a missing required parameter, an expired token, or a user or location ID that does not exist in your tenant.

Codes in the 5xx range indicate an error with Calven's servers. These are rare.

Endpoints that accept a batch of events, such as presence and occupancy, reject a badly formed request outright with a 4xx and load nothing. If the request is well formed but individual events cannot be processed, those events are reported in the response and the rest are loaded. The endpoint pages cover this.

Overview

Getting Started#

Using the APIs#

Handling Errors#

Getting Started

Using the APIs

Handling Errors