Calven
    Calven
    • Overview
    • Key Access Levels
    • Basic Authentication Overview
    • HMAC Authentication Overview
    • SDKs
    • Calven Data Models
    • HMAC Authentication
      • Generate a token with an API key and HMAC
        POST
      • Generate a token with an API key and client secret
        POST
    • Presence
      • Presence Overview
      • Submit presence events with BASIC auth
        POST
      • Submit presence events
        POST
    • Occupancy
      • Occupancy Overview
      • Submit occupancy events
        POST
    • Time off
      • Submit time off updates
        POST
    • Access Credentials
      • Submit access credentials
        POST
    • Warehouse - Basic Auth
      • Warehouse Overview
      • Users
        GET
      • Locations
        GET
      • Desks
        GET
      • Bookings & Attendance
        GET
      • Presence Details
        GET
      • User Actions Log
        GET
    • Warehouse - HMAC Auth
      • Warehouse Overview
      • Users
        GET
      • Locations
        GET
      • Desks
        GET
      • Bookings & Attendance
        GET
      • Presence
        GET
      • User Actions Log
        GET

    Overview

    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
    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. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Calven’s servers (these are rare).
    Next
    Key Access Levels
    Built with