---
title: "Query people"
method: POST
path: "/people/query"
tags: ["People"]
---

# Query people

`POST /people/query`

## Request

- Base URL: `https://api.klipy.ai/api/v1`
- URL: `https://api.klipy.ai/api/v1/people/query`
- Auth: one of:
  - API key in header `X-Klipy-Api-Key`
  - HTTP bearer

## Request body

- PeopleQueryRequest
  - `cursor` string
  - `limit` integer
  - `filter` PeopleQueryFilter
    - `email` string
    - `phone` string
    - `companyId` string
    - `owner` string

## Response `200`

People page returned

- PeopleListResponse
  - `object` string, required
  - `data` object[], required
    - `id` string
    - `email` string, email
    - `firstName` string
    - `lastName` string
    - `title` string
    - `phone` string
    - `personalPhone` string
    - `linkedin` string
    - `twitter` string
    - `facebook` string
    - `instagram` string
    - `whatsapp` string
    - `altEmails` string[]
    - `remarks` string
    - `companyId` string
    - `owner` string
    - `createdBy` string
    - `creationTime` string, date-time
    - `lastInteraction` string, date-time
  - `page_info` object, required
    - `has_next_page` boolean, required
    - `end_cursor` string, nullable, required
  - `meta` ApiMeta, required
    - `request_id` string, required
    - `api_version` string, required
    - `timestamp` string, date-time, required

## Other responses

- `401`: Missing or invalid API key
- `403`: Insufficient scope for this operation
- `422`: Validation error - request body failed validation
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/klipy/apis/klipy-api.md) · [All operations](https://skmtc.dev/klipy/apis/klipy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/klipy/apis/klipy-api/revisions/d0b77f2a62a8?raw)