Karbon

Connect your app with the API.

Leverage the Karbon API to integrate your apps with Karbon, build custom solutions, optimize workflows and power your business.

Register

Get started

Connect with the Karbon API and start building.

Get started

Explore the docs

Connect with the Karbon API and start building.

Explore the docs

Get support

Get fast support and log issues to help improve the API.

Get support

Build custom solutions, painlessly.

Go from idea to implementation quickly and painlessly with the Karbon API and documentation. Bring custom solutions to life in the language of your choice.

View the docs
  1. cURL
  2. JavaScript
  3. C#
  4. Java
  5. Python
# Retrieve a list of Karbon Users

curl https://api.karbonhq.com/v3/Users \
--header 'AccessKey: eyJ0eXAiOiJKV1QiL...' \
--header 'Authorization: Bearer 60a39912-382f-40a2...'
/* Create a new Note - due tomorrow! */

let note = JSON.stringify({
  Id: "2xfLMq5PFqb7",
  Subject: "Finish updating the API code examples",
  Body: "Think of a good javascript one!",
  AuthorEmailAddress: "sarah@karbonhq.com",
  AssigneeEmailAddress:"george@karbonhq.com",
  DueDate: "2020-08-19T03:34:14.056Z",
  TodoDate: "2020-08-18T03:34:14.056Z"
});

let requestOptions = {
  method: 'POST',
  headers: new Headers({
    AccessKey: "eyJ0eXAiOiJKV1QiL...",
    Authorization: "Bearer 60a39912-382f-40a2..."
  }),
  body: note,
};

fetch("https://api.karbonhq.com/v3/Notes", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result));
// Get Work items for 2021 that are ready to start 

using RestSharp;
var client = new RestClient("https://api.karbonhq.com");
var request = new RestRequest("/v3/WorkItems", DataFormat.Json)
  .AddHeader("AccessKey", "eyJ0eXAiOiJKV1QiL...")
  .AddHeader("Authorization", "Bearer 60a39912-382f-40a2...")
  .AddParameter(
    "$filter", 
    "WorkStatus eq 'Ready To Start' and year(ToDoPeriod) eq 2021"
  );
  
var response = client.Get(request);
Console.WriteLine(response.Content);
/* Get a list of Clients */

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url(" https://api.karbonhq.com/v3/Contacts")
  .addHeader("AccessKey", "eyJ0eXAiOiJKV1QiL...")
  .addHeader("Authorization", "Bearer 60a39912-382f-40a2...")
  .build();
  
  try (Response response = client.newCall(request).execute()) {
    return response.body().string();
  }
# Search for an Organization by Name

import requests
url = "https://api.karbonhq.com/v3/Organizations"

headers = {
  'AccessKey': 'eyJ0eXAiOiJKV1QiL...',
  'Authorization': 'Bearer 60a39912-382f-40a2...'
}

params = {
  '$filter': 'startswith(FullName,"Karbon")'
}


response = requests.get(url, headers=headers, params=payload)

print(response.text.encode('utf8'))

Get started

1. Register for a free acount

Register a developer account and request access to the Karbon API.

Register your developer account

2. Get your access keys

Retrieve your API and Tenant Access Keys from inside the Karbon app.

Where do I find my access keys?

3. Explore the API documentation

Browse the reference docs to work out which endpoints you'll need to start integrating.

Explore the documentation

4. Go live with your application

Enable your application to access Karbon and go live with your app!

Partner with Karbon: Accelerate growth for you and your customers

Are you a B2B SaaS company? Karbon works with vendors to bring together systems, people and data to improve the way accounting firms work. Partner with Karbon to maximize your customer experiences, reach new users and innovate together.

Email partnerships@karbonhq.com