Skip to main content

OpenAPI Specification

The Thirdfort Client API is documented using OpenAPI 3.0. Separate specifications are available for each API version. You can download them for use with code generators, API clients, and development tools.

Download​

The specifications are identical for both nonproduction and production environments — only the server URL differs.

v1 (Stable)​

Download directly: thirdfort-api-v1.yaml

Or via command line:

# Nonproduction
curl https://developers.thirdfort.dev/openapi-v1.yaml -o thirdfort-api-v1.yaml

# Production
curl https://developers.thirdfort.com/openapi-v1.yaml -o thirdfort-api-v1.yaml

v1alpha2 (Preview)​

Download directly: thirdfort-api-v1alpha2.yaml

Or via command line:

# Nonproduction
curl https://developers.thirdfort.dev/openapi-v1alpha2.yaml -o thirdfort-api-v1alpha2.yaml

# Production
curl https://developers.thirdfort.com/openapi-v1alpha2.yaml -o thirdfort-api-v1alpha2.yaml

What's Included​

Each OpenAPI specification contains:

  • All API endpoints for that version — complete documentation of request/response formats
  • Authentication requirements — OAuth 2.0 configuration details
  • Data schemas — Full type definitions for all resources
  • Examples — Sample requests and responses for key operations

Using the Specification​

Interactive Documentation​

Browse the API interactively using the API Reference.

Code Generation​

Generate type-safe client libraries for your preferred language. See the Code Generation guide for examples using:

  • C# / .NET — Microsoft Kiota
  • TypeScript — openapi-generator
  • Python — openapi-generator

API Testing Tools​

Import the specification into tools like:

tip

Most API testing tools can import OpenAPI specs directly via URL:

https://developers.thirdfort.dev/openapi-v1.yaml