APIs
A platform you can program against.
Every Thirdlane tenant is fully scriptable. REST endpoints with OpenAPI 3.1 specs, AMI/AGI for low-level call control, and webhooks for real-time events — so you can wire Thirdlane into billing, provisioning, helpdesks, CRMs, BI, and your own applications.
API surfaces
REST API
OpenAPI 3.1 with interactive Scalar documentation. 38+ documented endpoints covering tenants, extensions, DIDs, trunks, queues, agents, IVRs, time conditions, schedules, contact center, and the built-in CRM.
CRM API
Full CRUD for Contacts, Accounts, Leads, Lists, Custom Fields, Activities, Tasks, Campaigns, and Deals. Bulk import via /api/crm-contacts/{tenant}/import with import-preview and reusable import maps.
Organization API
Manage multi-site enterprises and their member organizations through /api/organization/. Full CRUD, site listing, and shared directory queries.
Outbound webhooks
Real-time HTTP notifications for CRM, configuration, and communications events. Grouped event selectors, test delivery, and a delivery log per subscription.
System webhooks
Cross-tenant provisioning automation — extension, DID, trunk, and tenant lifecycle events delivered from every tenant to a single subscription endpoint.
AMI / AGI
Asterisk Manager Interface and Asterisk Gateway Interface for low-level call control, real-time event streams, and custom dialplan extensions.
Authentication
Three authentication methods are supported across the API surface. Pick the one that fits your deployment — and rotate or revoke credentials independently.
API key (X-API-Key header)
Recommended for server-to-server integrations. Scoped per tenant with rotation and revocation.
HTTP Basic Auth
For administrative tooling and CLI workflows.
Session cookie
Used by the Configuration Manager UI and Thirdlane Connect; available for browser-based integrations.
Developer tooling
OpenAPI 3.1 spec
A combined specification file for Postman import, SDK generation, or your tooling of choice — downloadable from the API documentation UI.
Interactive testing
Try every endpoint live from the in-product Scalar console. No external client required.
Pagination & totals
limit/offset query parameters and X-Total-Count response headers across all list endpoints.
Structured errors
Standardized error response schemas with stable codes — write integrations that fail predictably.
Webhook payloads
Extension webhook events include phone_username (SIP peer name), location, and primary_server so receivers can route SIP traffic to the correct cluster without follow-up API calls.
Reference adapters
Custom SMS gateway provider ships with downloadable Perl, Python, and Node.js reference adapters.
Common integration patterns
- Provisioning automation — system webhooks fire on tenant, extension, DID, and trunk lifecycle events; subscribe once, receive from every tenant.
- Billing & usage export — REST endpoints feed CDRs, agent stats, and call counters into your billing or BI pipeline on a schedule.
- CRM screen pop & logging — outbound event webhooks push call events to your CRM in real time; the CRM API surfaces contacts and accounts the other direction.
- Custom SMS gateway — webhook-based provider integration with downloadable Perl, Python, and Node.js reference adapters for carriers without built-in support.
- Cluster-aware routing — extension webhook payloads carry the tenant’s primary_server so external SIP routing logic stays in sync.
Build on Thirdlane.
Walk through the API surface with our team and see how customers automate provisioning, billing, and CRM workflows on top of the platform.