people
companies
people
Query people records
POST
/
people
/
query
curl --request POST \
--url https://api.klipycrm.com/api/v1/people/query \
--header 'Content-Type: application/json' \
--header 'X-KLIPY-API-KEY: <api-key>' \
--data '{
"cursor": "<string>",
"limit": 20,
"filter": {
"email": "<string>",
"phone": "<string>",
"companyId": "<string>",
"owner": "<string>"
}
}'
{
"success": true,
"nextCursor": "<string>",
"data": {
"people": [
{
"id": "<string>",
"companyId": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"linkedin": "<string>",
"owner": "<string>",
"phone": "<string>",
"source": "<string>",
"title": "<string>",
"createdBy": "<string>",
"creationTime": "2023-11-07T05:31:56Z",
"lastInteraction": "2023-11-07T05:31:56Z"
}
]
}
}
Authorizations
Body
application/json
Query parameters for filtering people
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/people/query \
--header 'Content-Type: application/json' \
--header 'X-KLIPY-API-KEY: <api-key>' \
--data '{
"cursor": "<string>",
"limit": 20,
"filter": {
"email": "<string>",
"phone": "<string>",
"companyId": "<string>",
"owner": "<string>"
}
}'
{
"success": true,
"nextCursor": "<string>",
"data": {
"people": [
{
"id": "<string>",
"companyId": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"linkedin": "<string>",
"owner": "<string>",
"phone": "<string>",
"source": "<string>",
"title": "<string>",
"createdBy": "<string>",
"creationTime": "2023-11-07T05:31:56Z",
"lastInteraction": "2023-11-07T05:31:56Z"
}
]
}
}