Skip to content
Platform Documentation

REST API

The Thirdlane Platform provides a comprehensive REST API for programmatic management of PBX resources. The API allows external applications and scripts to create, read, update, and delete configuration objects.

API Documentation

Interactive API documentation is available on every Thirdlane installation. Access it from Tools > OpenAPI REST in Configuration Manager, or navigate to /apitest/openapi/ on your server.

The documentation is built on OpenAPI 3.1 specifications and provides:

  • Browsable API reference — All endpoints grouped by category (Platform Administration and Tenant Configuration)
  • Interactive testing — Execute API calls directly from the browser with your active session
  • Tenant selector — Dynamically switch the target tenant for tenant-scoped operations
  • Complete schemas — Request/response models with field descriptions, types, and examples

See the OpenAPI REST page for usage details and curl examples.

Covered APIs

The API covers 29 multi-tenant entities across two categories:

Platform Administration (global scope):

  • Tenants, Administrators, Resellers, Servers, Locations, SIP Trunks

Tenant Configuration (tenant-scoped):

  • User Extensions, Agents, Queues, Hunt Groups, Pickup Groups
  • Inbound Routes, Outbound Routes, DIDs
  • IVR/Voice Menus, Schedules, Feature Codes, Special Endpoints
  • Mailboxes, Conference Rooms, Company Contacts
  • Departments, Emergency Locations, Tags, Managed Devices
  • Web Call Widgets, Office Modes
  • API Keys, Webhooks

Authentication

API requests can be authenticated using:

  • Session cookie (sid) — Used by the interactive documentation UI
  • Basic Authentication — Username and password for programmatic access
  • API Keys — Create and manage keys in API Keys

Common Use Cases

  • Provisioning automation — Bulk create users, extensions, and routes from external systems
  • CRM integration — Look up caller information, log calls
  • Monitoring — Pull CDR data, check user status
  • Configuration management — Script repetitive configuration tasks

Integration Points

Beyond the REST API, the platform supports: