people
companies
interactions
Query interaction records
POST
/
interactions
/
query
curl --request POST \
--url https://api.klipycrm.com/api/v1/interactions/query \
--header 'Content-Type: application/json' \
--header 'X-KLIPY-API-KEY: <api-key>' \
--data '{
"cursor": "<string>",
"limit": 20,
"filter": {
"companyId": "<string>",
"contactId": "<string>"
}
}'
{
"success": true,
"data": {
"interactions": [
{
"id": "<string>",
"companies": [
"<string>"
],
"contacts": [
"<string>"
],
"direction": "INBOUND",
"sentiment": "MEETING_REQUESTED",
"source": "EMAIL",
"summary": "<string>",
"title": "<string>",
"type": "EMAIL",
"createdBy": "<string>",
"creationTime": "2023-11-07T05:31:56Z",
"interactionDate": "2023-11-07T05:31:56Z"
}
]
}
}
Authorizations
Body
application/json
Query parameters for filtering interactions
The body is of type object
.
Response
200
application/json
Success
The response is of type object
.
curl --request POST \
--url https://api.klipycrm.com/api/v1/interactions/query \
--header 'Content-Type: application/json' \
--header 'X-KLIPY-API-KEY: <api-key>' \
--data '{
"cursor": "<string>",
"limit": 20,
"filter": {
"companyId": "<string>",
"contactId": "<string>"
}
}'
{
"success": true,
"data": {
"interactions": [
{
"id": "<string>",
"companies": [
"<string>"
],
"contacts": [
"<string>"
],
"direction": "INBOUND",
"sentiment": "MEETING_REQUESTED",
"source": "EMAIL",
"summary": "<string>",
"title": "<string>",
"type": "EMAIL",
"createdBy": "<string>",
"creationTime": "2023-11-07T05:31:56Z",
"interactionDate": "2023-11-07T05:31:56Z"
}
]
}
}