Release Notes

June 20, 2022

We have made updates to Karbon's public API that impact 3 endpoint: Contacts, WorkItems and User.

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

In summary, we made changes to the following endpoints:

  1. JSONCopied!
    Contacts
  2. JSONCopied!
    WorkItems
  3. JSONCopied!
    User

Contacts

The

JSONCopied!
GET
method now lets you search for Contacts using only a part of
JSONCopied!
FullName
,
JSONCopied!
EmailAddress
, or
JSONCopied!
PhoneNumber
.

Example use case

You want to search the details of your

JSONCopied!
Contacts
whose full name contains the word "Ted". You could construct the
JSONCopied!
GET
URL to search the
JSONCopied!
FullName
field of your
JSONCopied!
Contacts
as:

JSONCopied!
https://api.karbonhq.com/v3/Contacts?$filter=(contains(FullName, 'Ted'))


WorkItems

The

JSONCopied!
GET
method now lets you search for Work Items using only a part of
JSONCopied!
Title
or
JSONCopied!
AssigneeEmailAddress
.

Example use case

You want to search for all Work Items assigned to email addresses that contain the text "John". You could construct the

JSONCopied!
GET
request to search the
JSONCopied!
AssigneeEmailAddress
field in your Work Items as:

JSONCopied!
https://api.karbonhq.com/v3/WorkItems?$filter=(contains(AssigneeEmailAddress , 'John'))


User

The

JSONCopied!
GET
method now lets you search for
JSONCopied!
Users
using only a part of
JSONCopied!
Name
or
JSONCopied!
EmailAddress
.

Example use case

You want to search for all users whose name contains the text "John". You could construct the

JSONCopied!
GET
URL to search the
JSONCopied!
Name
field of your
JSONCopied!
Users
as:

JSONCopied!
https://api.karbonhq.com/v3/Users?$filter=(contains(Name, 'John'))