Find conversations by client

Use our public API to find all conversations for a specific client.

Daniel Figueiredo avatar
Written by Daniel Figueiredo
Updated over a week ago

Role: Admin, Account Manager

How to find conversations by a specific client with API?

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 from that step to continue.

With the API token & account ID acquired, we can make a POST request to /api/v1/payment/10101/conversations/search, by setting the token as a Bearer token in the Authorization header. You should also pass in the client's email in the request body as:

{ "endUserEmail": "user@example.com" }

An example request with curl would look like this:

curl 'https://kibbles.klausapp.com/api/v1/account/<account_id>/conversations/search' \
-X POST \
-H 'accept: application/json' \
-H 'Authorization: Bearer <api_token>' \
-d '{ "endUserEmail": "user@example.com" }'

And this is the structure of the response:

{
"conversations": [
{
"id": "string",
"externalLink": "string"
},
{
"id": "string",
"externalLink": "string"
}
]
}

Where externalLink should link to the original help desk conversation.

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?