APIs
Integrate provisioning, operations, and customer data.
Thirdlane provides documented REST APIs for supported platform and CRM objects, outbound webhooks for selected events, and lower-level interfaces for telephony workflows. These interfaces support integration with provisioning, billing, CRM, helpdesk, and reporting systems.
Available interfaces
Choose a higher-level REST or webhook interface where it covers the workflow, and use AMI or AGI when direct telephony integration is required.
Configuration APIs
Manage supported tenants, extensions, DIDs, trunks, queues, agents, IVRs, schedules, and related configuration.
CRM APIs
Manage contacts, accounts, leads, lists, custom fields, activities, tasks, campaigns, and deals, including contact import workflows.
Organization APIs
Manage multi-site organizations, site membership, and shared-directory queries.
Outbound webhooks
Send selected configuration and CRM events to subscribed HTTP endpoints, with test delivery and delivery logs.
System webhooks
Subscribe once to selected tenant, extension, DID, and trunk lifecycle events across the platform.
Telephony event interfaces
Integrate call events, call control, and advanced routing workflows that require lower-level telephony access.
Authentication
The API accepts three authentication methods. Effective access follows the authenticated account and platform permissions.
API key
Send a generated key in the X-API-Key header. Keys can be revoked and record their last use.
HTTP Basic authentication
Use an authorized platform account for administrative tools and scripts.
Session cookie
Use an authenticated browser session for supported in-browser API workflows.
Documentation and tooling
OpenAPI 3.1 specification
Download a combined specification for API clients, testing tools, or SDK generation.
Interactive reference
Review schemas and submit authorized requests from the API documentation interface.
Pagination and totals
Use limit and offset on supported list operations and read result totals from response headers.
Documented errors
Use the common error response shape documented in the OpenAPI specifications.
Common integration patterns
- Provisioning — create and update supported tenants, users, extensions, numbers, and routing configuration.
- Billing and reporting — retrieve call and operational data for processing in external systems.
- CRM workflows — exchange customer records and connect supported click-to-call, lookup, and logging workflows.
- Custom messaging providers — connect an SMS gateway through the documented webhook-based provider interface.
Review the interfaces your integration needs.
Walk through supported objects, event coverage, authentication, and telephony interfaces with our team.