API Reference

RESTful API for device data,
alerts, venues, and more

Integrate Theatre Intelligence with your existing toolchain. Pull device metrics, push alerts to your systems, and automate venue operations. See the documentation for setup guides, browse available integrations, get help from the support centre, or explore the full feature set.

Base URL

https://api.theatreintelligence.com/v1

Authentication

All requests must be authenticated using an API key. Pass your key in the Authorization header as a Bearer token. Generate API keys in Settings → API Keys.

Example request

# Using curl
curl https://api.theatreintelligence.com/v1/devices \
  -H "Authorization: Bearer ti_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

# Response: 200 OK
{
  "data": [...],
  "meta": { "total": 42 }
}

Keep your API key secret. Never expose it in client-side code or public repositories. Use environment variables or a secrets manager.

Endpoints

Venues

5 endpoints

Manage venue records and their associated metadata.

GET /venues
GET /venues/{id}
POST /venues
PATCH /venues/{id}
DELETE /venues/{id}

Devices

6 endpoints

Query, register, and manage monitored devices at any venue.

GET /devices
GET /devices/{id}
POST /devices
PATCH /devices/{id}
DELETE /devices/{id}
GET /devices/{id}/metrics

Alerts

4 endpoints

Retrieve active alerts, acknowledge issues, and configure rules.

GET /alerts
GET /alerts/{id}
POST /alerts/{id}/acknowledge
DELETE /alerts/{id}

Reports

3 endpoints

Generate and export uptime and performance reports.

GET /reports/uptime
GET /reports/performance
POST /reports/export

Webhooks