July 12, 2022

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. WorkItems
2. Timesheet

WorkItem

We added a new search criterion called WorkType to the GET URL, allowing you to receive a filtered list of Work Items based on Work Type.

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 WorkType of “Payroll”. To search Work Items using the WorkType criterion, construct the GET URL as:

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

• Partial text search: You want to search the Work Items, whose WorkType contain the word “pay”. To search your Work Items using the WorkType criterion, construct the GET URL as:

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

Timesheet

We fixed the bug that was limiting you from searching the Timesheets using Status criteria.

Example use case

You want to search all Timesheets with the Status of “Draft”. To search your Timesheets using the Status criterion, construct the GET URL as:

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