API Reference
Atrium exposes a REST API for programmatic access to visitor management functionality. The API is the same interface used by the admin dashboard and the kiosk — there is no separate "integration API."
Base URL
https://<your-atrium-domain>/api/v1/
All API endpoints are prefixed with /api/v1/. The version prefix ensures backward compatibility when future API versions are introduced.
Design principles
- JSON throughout. All request and response bodies use
application/json. - Tenant-scoped. Every API request operates within a tenant context, determined by the authentication token.
- Site-scoped where applicable. Endpoints that operate on site-specific data (visits, kiosks, agent connections) include a site context.
- RESTful conventions. Standard HTTP methods (GET, POST, PUT, DELETE) with standard status codes.
- Consistent error format. Errors return a JSON body with
error(machine-readable code) andmessage(human-readable description).
Error format
{
"error": "visit_not_found",
"message": "No visit found with ID 550e8400-e29b-41d4-a716-446655440000"
}
Standard HTTP status codes:
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad request (validation error) |
| 401 | Unauthorized (missing or invalid token) |
| 403 | Forbidden (insufficient permissions or license limit reached) |
| 404 | Not found |
| 409 | Conflict (e.g., invalid state transition) |
| 429 | Rate limited |
| 500 | Internal server error |
API access entitlement
Programmatic API access requires the api_access entitlement in your license tier. Without this entitlement, only the dashboard and kiosk (which use the same API internally) can access the endpoints.
Interactive documentation
A full interactive API reference with request/response examples will be available at https://<your-atrium-domain>/api/docs when OpenAPI documentation is generated.