---
title: "Search people"
method: GET
path: "/search/people"
tags: ["Search People"]
---

# Search people

`GET /search/people`

## Request

- The document declares no server URL.
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/spott/apis/spott-webhooks/docs/search/people/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of people that match the provided filters. Searches across candidates and client contacts. You can search by full name, email address, or phone number. Results use fuzzy matching for partial matches and minor typos, ranked by relevance.

## Query parameters

- `query` string, required
- `limit` integer

## Response `200`

Successfully retrieved matching people. Returns a list of candidates and client contacts matching the search query.

- TenantWidePeopleEntitiesDto
  - `items` TenantWidePeopleItemDto[], required
    - union
      - object
        - `entityType` 'candidate', required
        - `id` string, required
        - `firstName` string, required
        - `middleName` string, nullable, required
        - `lastName` string, required
        - `secondLastName` string, nullable, required
        - `avatarUrl` string, nullable, required
        - `phoneNumbers` string[], nullable, required
        - `emailAddresses` string[], nullable, required
        - `linkedInUrl` string, nullable, required
      - object
        - `entityType` 'clientContact', required
        - `id` string, required
        - `candidateId` string, required
        - `firstName` string, required
        - `middleName` string, nullable, required
        - `lastName` string, required
        - `secondLastName` string, nullable, required
        - `avatarUrl` string, nullable, required
        - `companyId` string, required
        - `companyName` string, required
        - `companyLogoUrl` string, nullable, required
        - `phoneNumbers` string[], nullable, required
        - `emailAddresses` string[], nullable, required
        - `linkedInUrl` string, nullable, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized - invalid or missing authentication
- `500`: Error response

---

[API](https://skmtc.dev/spott/apis/spott-webhooks.md) - [All operations](https://skmtc.dev/spott/apis/spott-webhooks/llms.txt) - [OpenAPI document](https://skmtc.dev/spott/apis/spott-webhooks/revisions/ad1f8c51cf0a?raw)
