Skip to main content
POST
/
people
/
query
Query people
curl --request POST \
  --url https://api.klipy.ai/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>"
  }
}
'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "firstName": "<string>",
      "lastName": "<string>",
      "title": "<string>",
      "phone": "<string>",
      "personalPhone": "<string>",
      "linkedin": "<string>",
      "twitter": "<string>",
      "facebook": "<string>",
      "instagram": "<string>",
      "whatsapp": "<string>",
      "altEmails": [
        "jsmith@example.com"
      ],
      "remarks": "<string>",
      "companyId": "<string>",
      "owner": "<string>",
      "createdBy": "<string>",
      "creationTime": "2023-11-07T05:31:56Z",
      "lastInteraction": "2023-11-07T05:31:56Z"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "<string>"
  },
  "meta": {
    "request_id": "req_abc123",
    "api_version": "1",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-Klipy-Api-Key
string
header
required

API key passed as a header

Body

application/json
cursor
string
limit
integer
default:20
Required range: 1 <= x <= 100
filter
object

Response

People page returned

object
string
required
Example:

"list"

data
object[]
required
page_info
object
required
meta
object
required
Last modified on April 5, 2026