First, if you haven't already, go ahead and set up an API connection in your Klaus account. You will need the API token, account ID and workspace ID from that step to continue.

With the API token, account ID and workspace ID acquired, we can make a GET request to /api/v1/payment/42000/workspace/11759/reviews by setting the token as a Bearer token in the Authorization header.

An example request with curl would look like this:

curl 'https://kibbles.klausapp.com/api/v1/payment/<account_id>/workspace/<workspace_id>/reviews?direction=received&fromDate=2020-01-01T00%3A00%3A00%2B00%3A00&selfReview=exclude&step=week&toDate=2020-03-31T00%3A00%3A00%2B00%3A00' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <api_token>'


And this is the structure of the response:

{
"reviews": [
{
"reviewId": "string",
"reviewLink": "string",
"externalLink": "string",
"lastComment": "string",
"reviewer": "string",
"reviewee": "string",
"categories": [
{
"label": "string",
"score": 0
}
],
"score": 0
}
]
}


Please refer to our public API's specification page for all the available query parameters, including filtering by scorecard tags, comment hashtags, and more!

Did this answer your question?