Release Notes

August 2, 2022

We have made updates to Karbon's public API that impact the Organization endpoint.

This document provides an overview of the Aug 2, 2022 release of Karbon's Public API.

JSONCopied!
GET Organization by OrganizationKey

In addition to

JSONCopied!
BusinessCards
property, we have also added a new property -
JSONCopied!
Contacts
- to the
JSONCopied!
$expand
option in
JSONCopied!
GET
by
JSONCopied!
OrganizationKey
endpoint. Using the new property, you can receive a list of Contacts associated with the Organization specified using the
JSONCopied!
OrganizationKey
.

Example use case

You want to retrieve a list of contacts associated with an Organization. To receive these Contacts, use

JSONCopied!
GET
method on the URL as:

JSONCopied!
https://api.karbonhq.com/v3/Organizations/{OrganizationKey}?$expand=Contacts

You might also want to retrieve a list of both contacts and business cards associated with an Organization. To receive Contacts and BusinessCards at the same time, use

JSONCopied!
GET
method on the URL as:

JSONCopied!
https://api.karbonhq.com/v3/Organizations/{OrganizationKey}?$expand=Contacts,BusinessCards