Karbon
Log in
Release Notes

July 12, 2022

We have made updates to Karbon's public API that impact 2 endpoints, which are WorkItem and Timesheet.

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

In summary, we made changes to the following endpoints:

  1. JSONCopied!
    WorkItems
  2. JSONCopied!
    Timesheet

WorkItem

We added a new search criterion called

JSONCopied!
WorkType
to the
JSONCopied!
GET
URL, allowing you to receive a filtered list of Work Items based on Work Type.

JSONCopied!
WorkType
criterion supports both full text and partial text search.

Example use case

  • Full text search: You want to search the Work Items with the

    JSONCopied!
    WorkType
    of "Payroll". To search Work Items using the
    JSONCopied!
    WorkType
    criterion, construct the
    JSONCopied!
    GET
    URL as:

    JSONCopied!
    https://api.karbonhq.com/v3/WorkItems?$filter=WorkType eq 'Payroll'

  • Partial text search: You want to search the Work Items, whose

    JSONCopied!
    WorkType
    contain the word "pay". To search your Work Items using the
    JSONCopied!
    WorkType
    criterion, construct the
    JSONCopied!
    GET
    URL as:

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

Timesheet

We fixed the bug that was limiting you from searching the

JSONCopied!
Timesheets
using
JSONCopied!
Status
criteria.

Example use case

You want to search all

JSONCopied!
Timesheets
with the
JSONCopied!
Status
of "Draft". To search your
JSONCopied!
Timesheets
using the
JSONCopied!
Status
criterion, construct the
JSONCopied!
GET
URL as:

JSONCopied!
https://api.karbonhq.com/v3/Timesheets?$filter=Status eq 'Draft'

PrevNext
Google Play logoApp Store logoG2 rating
© Karbon 2024