Skip to content
Thirdlane

OpenAPI Documentation

Thirdlane provides built-in OpenAPI 3.1 documentation with an interactive API testing interface powered by Scalar.

Accessing the Documentation

The API documentation is available at /apitest/openapi/ on your Thirdlane server. Access it from Tools > OpenAPI REST in Configuration Manager.

Features

Interactive API Reference

The documentation provides a browsable reference of all 29 available API endpoints, organized into two categories:

  • Platform Administration — Global objects: Tenants, Administrators, Resellers, Servers, Locations, SIP Trunks
  • Tenant Configuration — Tenant-scoped objects: Extensions, Agents, Queues, Routes, Schedules, and more

Each endpoint shows:

  • HTTP method and URL path
  • Request parameters with descriptions and types
  • Request body schema with field definitions
  • Response schema with example data
  • Enumerated values for fields with fixed options

Tenant Selector

A tenant dropdown at the top of the page lets you choose the active tenant for tenant-scoped API calls. Selecting a tenant automatically updates all API paths and examples.

Try It (API Testing)

Click Test Request on any endpoint to execute a live API call using your active session. The interface sends the request directly to your server and displays the response. No separate authentication setup is needed.

API Specifications

The documentation is generated from OpenAPI 3.1 YAML specifications. These specs define every field, type, description, and example for each API endpoint. The specs serve as the single source of truth for both the documentation and the runtime API field mapping.

Covered APIs

The OpenAPI documentation covers all multi-tenant API operations. See OpenAPI REST for a complete list and curl examples.

Best practices

  • Use “Try It” for exploration, code for production. The live tester is ideal for learning an endpoint’s shape; once you know it, script against the API with an API key or Basic Auth from your own code.
  • Pick the right tenant before testing tenant-scoped calls. The tenant selector rewrites the paths and examples; running a call against the wrong tenant is the most common cause of “not found” surprises.
  • Download the spec to generate SDKs and Postman collections instead of hand-writing request models - the YAML is the single source of truth for fields and types.
  • OpenAPI REST - endpoint list, authentication, and curl examples.