KeyVox API Documentation

This is the complete API documentation for connecting to the KeyVox API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet KeyVox: KeyVox provides smart lock, locker, access, and reservation APIs for hospitality and property operations. Keep reading to get started.

Quickstart

Before you run your first KeyVox request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one KeyVox connection — create or choose one in Connections. Note its connectionId.

Every KeyVox action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/keyVox/latest/actions/{actionSlug}

You need a MindCloud API Key and a KeyVox connection. Then call an action such as Get Booking Details:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/keyVox/latest/actions/get-booking-details" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected KeyVox account that should run the action. MindCloud stores and refreshes the KeyVox credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

KeyVox actions

All 40 published actions for this KeyVox version. Each page documents the endpoint, arguments, and response controls.

• DELETECancel Booking
• PUTCheck In Booking
• PUTCheck Out Booking
• POSTCreate Booking
• POSTCreate Lock Card
• POSTCreate Lock PIN
• POSTCreate Locker PIN
• POSTCreate User
• DELETEDelete Lock Card
• DELETEDelete Lock PIN
• DELETEDelete Locker PIN
• GETGet Booking Details
• GETGet Lock Card Status
• GETGet Lock PIN Status
• GETGet Lock Status
• GETGet Locker Status
• GETGet Place Details
• GETGet Plan Details
• POSTIssue Lock Key
• GETList Available Places
• GETList Booking Orders
• GETList Bookings
• GETList Lock Cards
• GETList Lock Events
• GETList Lock History
• GETList Lock PINs
• GETList Lockers
• GETList Locks
• GETList Places
• GETList Plans
• GETList Reservable Units
• GETList Unit PINs
• GETList Units
• PUTSet Lock State
• PUTUnlock Locker
• PUTUpdate Booking
• PUTUpdate Lock Card
• PUTUpdate Lock PIN
• PUTUpdate Locker PIN
• PUTUpdate User

Related apps

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

GitHubNetlifyMySQLPostgreSQLFirebasePagerDutyGoogle Workspace AdminAdalo