Home

March 11, 2026

New Developer Quick-Reference Guide (Early Access)

We’ve published an early version of KARBON_API.md, a concise reference guide for developers and AI agents working with the Karbon API. This is a first cut — we’re actively looking to improve it based on real-world usage, and we’d love your feedback in the Karbon Community.

The guide is available in the API specification repository and currently covers:

  • Authentication — how to format the Authorization and AccessKey headers
  • Pagination — using $top, $skip, and @odata.nextLink
  • Filtering — supported $filter operators and fields per endpoint
  • Ordering and expanding — $orderby and $expand options by endpoint
  • Resource quick-reference — all available endpoints grouped by resource type
  • Key concepts — PrimaryStatus values, fee settings, webhook payloads, and more

Common Workflows

The guide also includes step-by-step workflows for common integration tasks:

  • Onboarding a new client (Contact, Organization, and Work Item creation)
  • Pulling timesheet data for active work items
  • Creating and assigning custom fields
  • Creating a Work Item from a Work Template
  • Setting up a monthly repeating Work Schedule
  • Subscribing to Invoice webhooks
  • Updating contact information via BusinessCards

If something is missing, unclear, or incorrect, let us know in the Karbon Community.