Developer Overview
Thirdlane is a programmable unified-communications engine. Beyond configuring the platform by hand, you can drive it from your own applications, scripts, and AI agents through a single, consistent REST API - place and control calls, send messages, pull reporting data, and manage every configuration object.
This Developers section is the entry point for building on Thirdlane. For the complete, always-current endpoint reference, use the interactive OpenAPI REST documentation on your own server (Tools > OpenAPI REST).
Three ways to see what the API covers, depending on what you are doing:
- Endpoint Index - every path and method as a plain list, readable without JavaScript. Start here if you are surveying what exists.
- OpenAPI REST - full schemas, field descriptions, and a try-it console.
https://your-server/apitest/openapi/thirdlane-api.yaml- the whole API merged into one OpenAPI 3.1 file. This is the authoritative contract; feed it to Postman, an SDK generator, or an AI agent rather than scraping the documentation.
API categories
The API is organized into a few clear categories. Thinking in these terms makes it easier to find the right endpoint and to reason about permissions.
- Actions - imperative verbs that make something happen: place a call, send a message, hang up, transfer, start or stop recording. See Actions.
- Reporting - historical, read-only data: call detail records (CDR), message detail records (MDR), and recorded calls with download links. See Reporting.
- Configuration - standard create/read/update/delete management of every PBX object (users, routes, queues, IVRs, DIDs, trunks, and more). Browse these in the OpenAPI REST reference.
- Import - source-neutral, idempotent endpoints for migrating historical data and media (recordings, voicemail, hold music, prompts, and bulk CDR). See Data Migration and Import.
- Telemetry (planned) - realtime, read-only visibility into active calls, presence, and queue/agent status.
- Events (planned) - webhooks and subscriptions for call, message, voicemail, and presence lifecycle events. Today, see Event Hooks and Outbound Webhooks.
Service planes
The platform is made up of several service planes - management, reporting, messaging, media, and Thirdlane Connect. Today they typically share one host; over time they can move to separate servers. So your code never hardcodes addresses, a discovery endpoint returns the base URL for each plane. Always resolve plane URLs from it rather than assuming a layout. See API Basics.
Where to start
- Read API Basics for authentication, base URLs, pagination, and error handling.
- Try an endpoint interactively in OpenAPI REST.
- Build against Actions and Reporting.
- For AI agents and partner integrations, see AI Agents and Partners.
Related documentation
- REST API - high-level overview and use cases
- OpenAPI REST - interactive reference and curl examples
- API Keys - create and manage authentication keys
- Data Migration and Import - import historical data and media