Skip to main content

OpenAPI Specification

The Thirdfort Client API is documented using OpenAPI 3.0. You can download the specification for use with code generators, API clients, and development tools.

Download

The specification is identical for both nonproduction and production environments. The API version, schemas, and functionality are the same—only the server URL differs.

Download directly: thirdfort-api-v1alpha2.yaml

Or via command line:

Nonproduction:

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

Production:

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

What's Included

The OpenAPI specification contains:

  • All API endpoints - 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, which renders the OpenAPI spec with a "Try It" interface.

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.yaml