Developer Documentation

Build with the GlassBox API

Integrate GlassBox into your applications with our powerful REST API. Create, manage, and embed widgets programmatically.

Quick Start

curl

# Get your API key from the dashboard
curl -X GET https://api.glassbox.live/v1/widgets \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Endpoints

GET/api/v1/widgetsList all your GlassBox widgets

POST/api/v1/widgetsCreate a new GlassBox widget

GET/api/v1/widgets/:idGet a specific widget's details

PATCH/api/v1/widgets/:idUpdate a widget's configuration

DELETE/api/v1/widgets/:idDelete a widget

GET/api/v1/widgets/:id/dataGet the current data for a widget

POST/api/v1/widgets/:id/refreshForce refresh a widget's data

GET/api/v1/sourcesList all connected data sources

API Features

API Key Authentication

Secure your requests with API keys. Generate and revoke keys from your dashboard.

Webhooks

Get notified when data changes with real-time webhook events.

RESTful API

Clean, predictable REST endpoints following industry best practices.

Rate Limiting

Generous rate limits with clear headers. 1000 requests/hour on Pro.

SDKs

Official SDKs for JavaScript, Python, Ruby, and PHP coming soon.

Low Latency

Global edge infrastructure ensures fast response times worldwide.

Ready to start building?

API access is available on Pro and Agency plans. Start your free trial today.