Calven
  1. Occupancy
Calven
  • Overview
  • Key Access Levels
  • Basic Authentication Overview
  • HMAC Authentication Overview
  • SDKs
  • Calven Data Models
  • Changelog
  • 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
    • Groups
      GET
    • Locations
      GET
    • Desks
      GET
    • Bookings & Attendance
      GET
    • Presence Details
      GET
    • User Actions Log
      GET
  • Warehouse - HMAC Auth
    • Warehouse Overview
    • Users
    • Groups
    • Locations
    • Desks
    • Bookings & Attendance
    • Presence
    • User Actions Log
  • analytics
  • Schemas
    • Schemas
      • PresenceEventDto
      • LeaveRequestBody
      • SyncFreeBusyDto
      • DWGroupsResponseDto
      • CreatePresenceEventDto
      • TimeoffRequestBody
      • TimeOffEvent
      • GetConsentUrlResponseDto
      • EventResultDto
      • TimeoffResponse
      • O365IntegrationConfigDto
      • CreatePresenceEventResponseDto
      • TimeoffEventResponse
      • CreateO365IntegrationDto
      • ResultCodes
      • ApiServiceException
      • IntegrationCreatedDto
      • OccupancyEventDto
      • GetO365IntegrationConfigDto
      • CreateOccupancyEventDto
      • GetO365IntegrationDto
      • CreateOccupancyEventResponseDto
      • PatchO365IntegrationConfigDto
      • AuthRequestDto
      • PatchO365IntegrationDto
      • VisitorArrivalEventDto
      • AuthResponseDto
      • ListRoomConnectionsDto
      • OAuthRequestDto
      • MappedSpaceDto
      • CreateVisitorArrivalEventDto
      • OAuthResponseDto
      • RoomConnectionDto
      • AccessCredentialUpdateResultCodes
      • CreateRoomConnectionDto
      • CreateVisitorArrivalEventResponseDto
      • AccessCredentialUpdateResult
      • CreateRoomConnectionResponseDto
      • AccessCredentialUpdateResponse
      • PatchRoomConnectionDto
      • AccessCredential
      • ListRoomResourcesDto
      • AccessCredentialUpdate
      • CreateGoogleWorkspaceIntegrationConfigDto
      • AccessCredentialUpdateRequest
      • CreateGoogleWorkspaceIntegrationDto
      • GetGoogleWorkspaceConfigDto
      • GetGoogleWorkspaceIntegrationDto
      • BasePatchIntegrationConfigDto
      • PatchGoogleWorkspaceIntegrationDto
      • CalendarEventConferencingDetailsDto
      • CalendarEventEmailNameDto
      • CalendarEventRemindersDto
      • CalendarEventDto
      • ListCalendarEventsDto
      • CreateCalendarEventDto
      • DWChangeLogUserResponseDto
      • DWUserBookingAttendanceResponseDto
      • DWPresenceResponseDto
      • DWUsersResponseDto
      • DWLocationsResponseDto
      • DWDesksResponseDto
  1. Occupancy

Submit occupancy events

POST
/v1/occupancy
Submit occupancy events to Calven.

Request

Body Params application/json

Example
{
    "sourceId": "string",
    "occupancyEvents": [
        {
            "timestamp": "2021-09-01T12:00:00.000Z",
            "locationId": "string",
            "locationType": "level",
            "eventId": "string",
            "occupied": true,
            "occupancy": 0
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.calven.com/v1/occupancy' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sourceId": "string",
    "occupancyEvents": [
        {
            "timestamp": "2021-09-01T12:00:00.000Z",
            "locationId": "string",
            "locationType": "level",
            "eventId": "string",
            "occupied": true,
            "occupancy": 0
        }
    ]
}'

Responses

🟢200Success
application/json
Body

Example
{
    "sourceId": "string",
    "timestamp": "2021-09-01T12:00:00.000Z",
    "results": [
        {
            "eventId": "string",
            "resultCode": 0,
            "message": "string"
        }
    ]
}
🟠401Payload when auth header is missing or invalid
Modified at 2025-04-03 13:58:50
Previous
Occupancy Overview
Next
Submit time off updates
Built with