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 criteria - WorkType
- to the GET URL, allowing you to receive a filtered list of Work Items based on Work Type.
WorkType
criteria supports both full text and partial text search.
Example use case
(Full text search) You want to search the Work Items with the
WorkType
- "Payroll". To search the your Work Items using theWorkType
criteria, 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 theWorkType
criteria, 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 - "Draft". To search your Timesheets using the Status
criteria, construct the GET URL as:
https://api.karbonhq.com/v3/Timesheets?$filter=Status eq 'Draft'