canonical: https://jentic.com/apis/kleverkey.com/kleverkey

# KleverKey API

Jentic publishes the only available OpenAPI specification for KleverKey API, keeping it validated and agent-ready. KleverKey is a smart lock and access management platform for offices, co-working spaces, and short-term rentals. The API exposes organizations, access groups, smart cards, gateways, locks, invitations, bookings, lock activation links, and the underlying event log, so an operator can provision a lock fleet, hand out access invitations, and audit who entered which door. It is well suited for property managers and co-working operators who need programmatic access control alongside their booking system.

## For AI agents

Provision smart locks, issue access invitations, manage smart cards and gateways, and audit door events on the KleverKey access platform.

## Scope

Does not handle CCTV video, alarm systems, or visitor identity verification - use for smart lock provisioning, access invitations, smart card management, and door event auditing only.

## Capabilities

- Provision an organization and its access groups on KleverKey
- Register and inspect smart locks attached to a KleverKey gateway
- Issue an access invitation so a guest can unlock a specific door
- Bind a physical smart card to a user inside an organization
- Pull the event log to audit lock unlocks and access attempts
- Manage bookings that grant time-bound access to a lock
- Generate a lock activation link for a freshly installed device

## Use cases

### Property Manager Access Control

Manage building access for a multi-tenant property without distributing keys. The `/api/v1/organizations/{organizationId}/locks` and `/api/v1/organizations/{organizationId}/invitations` endpoints let an operator add a lock, assign it to an access group, and invite a tenant in one workflow. Useful for serviced apartments, short-term rentals, and small property portfolios where tenants rotate frequently.

Example prompt: Create an invitation under organization 42 for guest email guest@example.com tied to lock id LK-001 valid until next Sunday.

### Co-Working Booking Integration

Wire KleverKey into a co-working booking flow so a confirmed booking automatically unlocks the right door at the right time. The `/api/v1/organizations/{organizationId}/bookings/{serviceName}` endpoint creates a booking record bound to a lock and a window. Combined with the gateway and lock endpoints, an operator can run a fully automated unattended access flow for desks and meeting rooms.

Example prompt: Create a booking under organization 42 for service 'meeting-room-A' from 14:00 to 15:00 today for user member@example.com.

### Access Audit and Event Reporting

Build a security audit feed by polling the KleverKey event log. The `/api/v1/event-log` endpoint returns lock unlocks, failed attempts, and gateway events that can be replayed into a SIEM, Slack channel, or compliance report. Best suited for facility managers who need a tamper-evident record of physical access for shared offices and regulated spaces.

Example prompt: Pull the KleverKey event log for the last 24 hours and post a summary of unlock events per lock to a Slack channel.

### Smart Card Lifecycle Management

Manage the full lifecycle of physical smart cards in a KleverKey deployment. The `/api/v1/organizations/{organizationId}/devices/smart-cards` endpoint registers a card to a user and can revoke it later, so an HR or IT team can offboard departing staff without changing locks. Pairs naturally with HR systems that drive hiring and termination events.

Example prompt: Register a new smart card with id SC-99887 under organization 42 and bind it to user employee@example.com.

### Agent-Driven Facility Operations via Jentic

Let an AI agent answer facility questions like 'who entered the lab last night' or 'invite this contractor for tomorrow' by calling KleverKey through Jentic. The agent searches Jentic for the right access operation, loads the schema, and executes with the API key drawn from your Jentic One instance. Far faster than wiring a custom KleverKey client into the operator's tooling.

Example prompt: Through Jentic, search for 'list KleverKey event log', load the `/api/v1/event-log` operation, and report failed unlock attempts in the last hour.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/event-log` | Retrieve the access event log |
| GET | `/api/v1/organizations` | List organizations |
| GET | `/api/v1/organizations/{organizationId}/locks` | List locks for an organization |
| GET | `/api/v1/organizations/{organizationId}/access-groups` | List access groups |
| POST | `/api/v1/organizations/{organizationId}/invitations` | Send a guest access invitation |
| POST | `/api/v1/organizations/{organizationId}/devices/smart-cards` | Register a smart card |
| POST | `/api/v1/organizations/{organizationId}/bookings/{serviceName}` | Create a booking that grants access |

## Key resources

- **Organizations** — Create and inspect KleverKey customer organizations
- **Access Groups** — Group users and locks for permissioning
- **Locks** — Register and manage smart locks tied to a gateway
- **Gateways** — Manage the gateways that bridge locks to the platform
- **Smart Cards** — Provision and revoke physical access cards
- **Invitations** — Send time-bound access invitations to guests
- **Bookings** — Create bookings that grant scheduled access to a lock
- **Event Log** — Audit unlock events and access attempts

## Why Jentic

- **Setup:** Wiring KleverKey by hand means learning its Authorization-header API key and handling the KleverKey API host and its errors yourself. Through Jentic you install once, import KleverKey from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** KleverKey puts the organization id in the URL path (`/organizations/{organizationId}/locks`), so a rule can pin your agent to one organization: it can read that organization's locks and event logs and nothing else. You choose the operations it may call, so sending access invitations or issuing smart cards are not included unless you add them.
- **Credential handling:** Your KleverKey API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list locks for an organization' or 'read door event logs', and Jentic returns the matching KleverKey operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Calendly API** — Booking system that pairs with KleverKey to grant access at the booked time
- **Stripe API** — Handles payment for the bookings that KleverKey grants access to
- **Airtable API** — Common back-of-house store for tenant and booking data alongside KleverKey access

## FAQ

### Why is there no official OpenAPI spec for KleverKey API?

KleverKey does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call KleverKey API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the KleverKey API use?

The KleverKey API uses an API key sent in the Authorization header on every request. Through Jentic, the API key is stored in your Jentic One instance and injected into the request at execution time so the agent never holds the raw key.

### Can I issue a guest invitation through the KleverKey API?

Yes. POST `/api/v1/organizations/{organizationId}/invitations` creates a time-bound invitation for a specific lock or access group. The recipient receives a link they can use to unlock the door during the configured window.

### What are the rate limits for the KleverKey API?

KleverKey does not publish a public rate limit and the spec does not declare one. Treat per-organization endpoints as moderately throttled and avoid tight polling on `/api/v1/event-log`; use longer windows or webhooks where available.

### How do I audit door unlocks through Jentic?

Search Jentic for 'KleverKey event log', load the GET `/api/v1/event-log` operation, and execute with a time range. Jentic injects the API key from the vault and returns the structured event entries for the agent to summarise.

### Does the KleverKey API expose smart card management?

Yes. POST `/api/v1/organizations/{organizationId}/devices/smart-cards` registers a card for an organization and binds it to a user. This makes onboarding and offboarding employees programmatic instead of a manual desk operation.

### Can I limit what my agent is allowed to do with the KleverKey API?

Yes. Because you run Jentic One yourself, your own rules decide which KleverKey operations and credentials your agent may use. Since KleverKey puts the organization id in the URL path, such as `/api/v1/organizations/{organizationId}/locks`, you can pin the agent to a single organization so it only reads that organization's locks and event log. You choose the operations it may call, so writes like POST invitations or POST smart-cards stay off limits unless you explicitly allow them.