interactions
Query interaction records
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
Cursor to start the query from
Number of records to return
Example:
20
Response
200
application/json
Success
Unique ID of interaction record
Array of company IDs associated with this interaction
Array of contact IDs associated with this interaction
Direction of the interaction (INBOUND, OUTBOUND, HYBRID, EVENT)
Available options:
INBOUND, OUTBOUND, HYBRID, EVENT Sentiment of the interaction
Example:
"MEETING_REQUESTED"
Source of the interaction
Example:
"EMAIL"
Detailed summary of the interaction, may contain HTML
Title or subject of the interaction
Type of interaction
Example:
"EMAIL"
ID of the user who created this interaction record
Timestamp when the interaction record was created
Timestamp when the interaction occurred
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"
}
]
}
}