---
title: "Retrieve search results"
method: POST
path: "/searches/perform"
tags: ["Searches"]
---

# Retrieve search results

`POST /searches/perform`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/searches/perform`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `app-key`
  - API key in query parameter `api_key` and API key in query parameter `app_key`

## Request body

- object
  - `search` SearchWritable
    - `name` string: This search's human-readable name
    - `search_type` 'people' | 'deals' | 'companies' | 'activities': The type of record this search runs on
    - `query` object: The search query, mapping column identifiers to the string value being searched for
    - `columns` string[]: The list view columns / search result attributes this search displays and returns

## Response `200`

Successful Response

- SearchResults
  - `columns` object[]: List of columns selected for this search
    - `type` string: data type of column
    - `length` integer: maximum length of column (for string)
    - `human_name` string: column heading name (humanized)
    - `id` string: column name
    - `primary_key` string: only for primary_key columns
  - `entries` array[]: Search results returned as an Array of Array of values (according to the pagination window specified).
    - union[]
      - union: Cell value as the column's type (string, number or boolean); null when the record has no value for that column
        - string, nullable
        - number
        - boolean
  - `pagination` object
    - `page` integer: The pagination counter (page number) of the results returned
    - `pages` integer: The total number of pages the results have been paginated into.
    - `per_page` integer: How many results have been requested per page
    - `total` integer: Total number of results available to be paginated through

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)