1. Default module
Calven Developer Docs
latest
  • latest
  • beta
  • Default module
    • Overview
    • Access Control
    • Basic Authentication
    • HMAC Authentication
    • SDKs
    • Calven Data Models
    • Changelog
    • Authentication
      • Generate a token with an API key and HMAC
      • Generate a token with an API key and client secret
    • Presence
      • Presence Overview
      • Submit presence events
      • Submit presence events (Basic auth)
    • Occupancy
      • Occupancy Overview
      • Submit occupancy events
    • Time Off
      • Submit time off updates
    • Access Credentials
      • Submit access credentials
    • Warehouse - Basic Auth
      • Warehouse API (Basic Auth)
      • Users (Basic auth)
      • Groups (Basic auth)
      • Locations (Basic auth)
      • Desks (Basic auth)
      • Bookings & Attendance (Basic auth)
      • Presence (Basic auth)
      • User Actions Log (Basic auth)
      • Events (Basic auth)
    • Warehouse - HMAC Auth
      • Warehouse API (HMAC Auth)
      • Users
      • Groups
      • Locations
      • Desks
      • Bookings & Attendance
      • Presence
      • User Actions Log
      • Events
    • Hierarchy Information
      • Org Hierarchy Information Overview
      • Submit group hierarchy relationships
      • Submit group hierarchy relationships (Basic auth)
    • Parking
      • Retrieve parking bookings
      • Retrieve parking bookings (Basic auth)
    • Service Requests
      • Service Offerings
      • Service Offering
      • Submit a service request
      • Service Request
      • Update a service request
    • User Attributes
      • User Attributes Overview
      • Write directory user attributes
      • Write directory user attributes (Basic auth)
    • Visitor Management
      • Submit visitor arrival events
      • Submit visitor arrival events (Basic auth)
  1. Default module

Overview

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

Getting Started#

Start by reading Access Control 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.
Modified at 2026-09-01 04:40:13
Next
Access Control
Built with