--- updatedAt: 2025-08-11T18:18:17.000Z agentTools: projectIndex: https://docs.keycafe.com/llms.txt --- # Retrieve Key Retrieve data for a single key with a GET request to the endpoint with an ID. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Keycafe API", "version": "0" }, "x-explorer-enabled": true, "x-proxy-enabled": true, "x-samples-languages": [ "shell", "python", "go" ], "servers": [ { "url": "https://www.keycafe.com/" } ], "components": { "securitySchemes": { "BasicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "BasicAuth": [] } ], "paths": { "/v0/key/{key_id}": { "get": { "tags": [ "Key" ], "summary": "Retrieve Key", "description": "Retrieve data for a single key with a GET request to the endpoint with an ID.", "operationId": "retrieve-key", "parameters": [ { "name": "key_id", "in": "path", "required": true, "description": "The unique identifier of the key.
Example: 123456", "schema": { "type": "integer", "format": "int64", "default": "" } } ], "responses": { "200": { "description": "Successful response with key details.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the key.", "example": 123456 }, "name": { "type": "string", "description": "Name of the key.", "example": "Bob's Home Key" }, "description": { "type": "string", "description": "Description of the key.", "example": "The front door key" }, "serialNumber": { "type": "string", "description": "Serial number of the key's fob.", "example": "XXXXX" }, "notes": { "type": "string", "description": "Internal notes about the key.", "example": "The cleaners come every Monday at 10:00" }, "pickupNote": { "type": "string", "description": "Note shown to guest after pickup.", "example": "Don't mind the dog. He's harmless." }, "address": { "type": "object", "description": "Address associated with the key.", "properties": { "street": { "type": "string", "description": "Street name.", "example": "123 Main St." }, "unit": { "type": "string", "description": "Unit or apartment number.", "example": "1A" }, "city": { "type": "string", "description": "City name.", "example": "Vancouver" }, "stateProv": { "type": "string", "description": "State or province.", "example": "BC" }, "country": { "type": "string", "description": "Country name.", "example": "Canada" }, "postalCode": { "type": "string", "description": "Postal or ZIP code.", "example": "A1A1A1" } } }, "homeLocation": { "type": "object", "description": "Default drop-off location for the key.", "properties": { "id": { "type": "integer", "description": "Unique identifier for the home location.", "example": 123456 }, "name": { "type": "string", "description": "Name of the home location.", "example": "Corner Cafe" }, "timezone": { "type": "string", "description": "Timezone of the home location.", "example": "America/Vancouver" }, "address": { "type": "object", "description": "Address of the home location.", "properties": { "street": { "type": "string", "description": "Street name.", "example": "123 Main St." }, "unit": { "type": "string", "description": "Unit or apartment number.", "example": "1A" }, "city": { "type": "string", "description": "City name.", "example": "Vancouver" }, "stateProv": { "type": "string", "description": "State or province.", "example": "BC" }, "country": { "type": "string", "description": "Country name.", "example": "Canada" }, "postalCode": { "type": "string", "description": "Postal or ZIP code.", "example": "A1A1A1" }, "latitude": { "type": "number", "description": "Latitude coordinate.", "example": 9.2839043 }, "longitude": { "type": "number", "description": "Longitude coordinate.", "example": -123.1053527 } } }, "hours": { "type": "array", "description": "Open hours of the home location.", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week (0 = Sunday).", "example": 0 }, "startMinuteOfDay": { "type": "integer", "description": "Start time in minutes since midnight.", "example": 360 }, "endMinuteOfDay": { "type": "integer", "description": "End time in minutes since midnight.", "example": 1320 } } } } } }, "currentLocation": { "type": "object", "description": "Current physical location of the key.", "properties": { "id": { "type": "integer", "description": "Unique identifier for the current location.", "example": 123456 }, "name": { "type": "string", "description": "Name of the current location.", "example": "Corner Cafe" }, "timezone": { "type": "string", "description": "Timezone of the current location.", "example": "America/Vancouver" }, "address": { "type": "object", "description": "Address of the current location.", "properties": { "street": { "type": "string", "description": "Street name.", "example": "123 Main St." }, "unit": { "type": "string", "description": "Unit or apartment number.", "example": "1A" }, "city": { "type": "string", "description": "City name.", "example": "Vancouver" }, "stateProv": { "type": "string", "description": "State or province.", "example": "BC" }, "country": { "type": "string", "description": "Country name.", "example": "Canada" }, "postalCode": { "type": "string", "description": "Postal or ZIP code.", "example": "A1A1A1" }, "latitude": { "type": "number", "description": "Latitude coordinate.", "example": 9.2839043 }, "longitude": { "type": "number", "description": "Longitude coordinate.", "example": -123.1053527 } } }, "hours": { "type": "array", "description": "Open hours at the current location.", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week (0 = Sunday).", "example": 0 }, "startMinuteOfDay": { "type": "integer", "description": "Start time in minutes since midnight.", "example": 360 }, "endMinuteOfDay": { "type": "integer", "description": "End time in minutes since midnight.", "example": 1320 } } } } } }, "currentUser": { "type": "object", "description": "User currently in possession of the key.", "properties": { "id": { "type": "integer", "description": "User ID.", "example": 123456 }, "email": { "type": "string", "description": "User's email address.", "example": "user@yourdomain.com" }, "mobile": { "type": "string", "description": "User's phone number.", "example": 16042656073 }, "firstName": { "type": "string", "description": "User's first name.", "example": "Bob" }, "lastName": { "type": "string", "description": "User's last name.", "example": "Smith" } } }, "owner": { "type": "object", "description": "Owner of the key.", "properties": { "id": { "type": "integer", "description": "Owner's ID.", "example": 123456 }, "email": { "type": "string", "description": "Owner's email address.", "example": "user@yourdomain.com" }, "mobile": { "type": "string", "description": "Owner's phone number.", "example": 16042656073 }, "firstName": { "type": "string", "description": "Owner's first name.", "example": "Bob" }, "lastName": { "type": "string", "description": "Owner's last name.", "example": "Smith" } } }, "accesses": { "type": "array", "description": "List of access permissions associated with the key.", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Access entry ID.", "example": 123456 }, "startDate": { "type": "string", "format": "date-time", "description": "Start date/time of the access.", "example": "2025-07-21T12:45:21Z" }, "endDate": { "type": "string", "format": "date-time", "description": "End date/time of the access.", "example": "2025-07-23T12:45:21Z" }, "returnReminder": { "type": "boolean", "description": "Whether the guest will receive a return reminder.", "example": false } } } }, "roaming": { "type": "boolean", "description": "Determines if the key can be dropped off at any location" } } }, "examples": { "Result": { "value": "{\n \"id\": 123456,\n \"name\": \"Bob's Home Key\",\n \"description\": \"The front door key\",\n \"serialNumber\": \"XXXXX\",\n \"notes\": \"The cleaners come every Monday at 10:00\",\n \"pickupNote\": \"Don't mind the dog. He's harmless.\",\n \"address\": {\n \"street\": \"123 Main St.\",\n \"unit\": \"1A\",\n \"city\": \"Vancouver\",\n \"stateProv\": \"BC\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"homeLocation\": {\n \"id\": 123456,\n \"name\": \"Corner Cafe\",\n \"timezone\": \"America/Vancouver\",\n \"address\": {\n \"street\": \"123 Main St.\",\n \"unit\": \"1A\",\n \"city\": \"Vancouver\",\n \"stateProv\": \"BC\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\",\n \"latitude\": 9.2839043,\n \"longitude\": -123.1053527\n },\n \"hours\": [\n { \"dayOfWeek\": 0, \"startMinuteOfDay\": 360, \"endMinuteOfDay\": 1320 }\n ]\n },\n \"currentLocation\": {\n \"id\": 123456,\n \"name\": \"Corner Cafe\",\n \"timezone\": \"America/Vancouver\",\n \"address\": {\n \"street\": \"123 Main St.\",\n \"unit\": \"1A\",\n \"city\": \"Vancouver\",\n \"stateProv\": \"BC\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\",\n \"latitude\": 9.2839043,\n \"longitude\": -123.1053527\n },\n \"hours\": [\n { \"dayOfWeek\": 0, \"startMinuteOfDay\": 360, \"endMinuteOfDay\": 1320 }\n ]\n },\n \"currentUser\": {\n \"id\": 123456,\n \"email\": \"user@yourdomain.com\",\n \"mobile\": \"16042656073\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Smith\"\n },\n \"owner\": {\n \"id\": 123456,\n \"email\": \"user@yourdomain.com\",\n \"mobile\": \"16042656073\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Smith\"\n },\n \"accesses\": [\n {\n \"id\": 123456,\n \"startDate\": \"2025-07-21T12:45:21Z\",\n \"endDate\": \"2025-07-23T12:45:21Z\",\n \"returnReminder\": false\n }\n ],\n\"roaming\": true}\n" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```