API Reference
PlaceOS API Reference
Section titled “PlaceOS API Reference”In order to use the PlaceOS API and Staff API, you will need to obtain an API Key to accompany all API Requests.
To generate an API Key you can follow the instructions to generate an X-API Key.
PlaceOS has two main APIs, you can navigate to the API Swagger using the links below or in the left navigation menu:
REST API
Section titled “REST API”The main PlaceOS REST API provides access to all core functionality including systems, modules, zones, and more.
Staff API
Section titled “Staff API”The Staff API provides specialized endpoints for staff directory integration and calendar access.
WebSocket API
Section titled “WebSocket API”For real-time communication and live updates, PlaceOS provides a WebSocket API.
- WebSocket API - Real-time communication documentation
Authentication
Section titled “Authentication”All API requests require authentication using API keys:
- X-API Keys - Generate and manage API keys for authentication