---
title: "List searches"
method: GET
path: "/searches"
tags: ["Searches"]
---

# List searches

`GET /searches`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/searches`
- 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`

## Response `200`

Successful Response

- object
  - `entries` SearchAll[], required
    - `id` integer: ID of the [search](#tag/searches)
    - `search_type` 'people' | 'deals' | 'companies' | 'activities': The type of record this search runs on
    - `is_default` boolean: Whether or not this search is provided by default
    - `is_starred` boolean: Whether or not this search is starred
    - `is_shared` boolean: Whether or not this search is shared with other users
    - `user_id` integer: The ID of the [user](#tag/users) who created this search
    - `sort` string: Sort order and column for search results.
    - `name` string: This search's human-readable name
    - `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
  - `pagination` Pagination, required: Paging details returned alongside `entries` on every paginated list.
    - `page` integer: The page returned. Request another with `?page=N`.
    - `per_page` integer: Page size. `?per_page=N`, capped at 200.
    - `total` integer: Total number of records matching the request across all pages.
    - `pages` integer: Number of pages at this `per_page`.
    - `total_in_account` integer, nullable: Total number of records of this type visible to you before filters were applied. Null when not computed for the endpoint.
    - `page_var` string: Name of the query parameter that selects the page. Always `page`.
    - `url` string, nullable: Path of the request, when the endpoint reports it.

## Other responses

- `422`: The request was understood but a value is missing, invalid or too long.

---

[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)