Karbon API Reference

This repository contains the OpenAPI 3.1.0 specification for the Karbon API (v3), along with hosted documentation and developer resources. API release notes and guides can be found at developers.karbonhq.com.

Contents

File	Description
KarbonAPI.json	OpenAPI 3.1.0 specification for the Karbon API v3
KARBON_API.md	Developer quick-reference guide covering authentication, pagination, filtering, and common patterns
vacuum-rules.yaml / vacuum.conf.yaml	Linting rules for the OpenAPI spec using Vacuum

Hosted Documentation

The API reference is published via GitHub Pages:

• API Reference UI: https://karbonhq.github.io/karbon-api-reference/
• OpenAPI Spec: https://karbonhq.github.io/karbon-api-reference/KarbonAPI.json
• Developer Guide: https://karbonhq.github.io/karbon-api-reference/KARBON_API.md

API Overview

See KARBON_API.md for full details on authentication, pagination, filtering, and common usage patterns.