April 26, 2022
We have made updates to Karbon's public API that impact 3 endpoints: ClientRequests, ClientTaskComments and ClientTasks
High level summary
This document outlines the changes to Karbon's public API as a result of the Karbon release on April 26, 2022.
In summary, the API changes impact only 3 endpoints:
- JSONCopied!
ClientRequests
- JSONCopied!
ClientTaskComments
- JSONCopied!
ClientTasks
ClientRequests
Use parentheses syntax instead of slash to request a single entity:
/v3/ClientRequests('{key}')
In a previous release of the API, individual entities were requested by slash syntax:
/v3/ClientRequests/{key}
The response from this endpoint will now have the same format whether querying it as a collection with
In particular, the
ClientRequestRecipientKey
Recipient
In a previous release of the API, the
ClientRequestRecipientKey
It is now possible to search for client requests with a given
ClientRequestRecipientKey
/v3/ClientRequests/?$filter=Recipient/ClientRequestRecipientKey eq 'ABC123'
ClientTaskComments, ClientTasks
Use parentheses syntax instead of slash to request a single entity. This applies to all verbs already supported by these endpoints (
GET
PATCH
ClientTasks
GET
POST
PATCH
DELETE
ClientTaskComments
/v3/ClientTasks('{key}')
/v3/ClientTaskComments('{key}')
In a previous release of the API, individual entities were requested by slash syntax:
/v3/ClientTasks/{key}
/v3/ClientTaskComments/{key}