---
title: "Search across the CRM"
method: GET
path: "/v1/search"
tags: ["search"]
---

# Search across the CRM

`GET /v1/search`

## Request

- Base URL: `https://api.indraft.io`
- URL: `https://api.indraft.io/v1/search`
- Auth: HTTP bearer

Search companies, contacts, opportunities, tasks, interaction summaries, and this workspace's own records by keyword. Matches whole words, prefixes, and substrings, so three characters from the middle of a name finds the record. Supports OR, a leading minus to exclude a term, a phrase in double quotes, and field qualifiers such as name:, domain: and email:. It finds records; it never decides that two records are the same one.

## Query parameters

- `q` string, required: The keyword. Matches whole words, prefixes and substrings, and supports OR, a leading minus to exclude, a quoted phrase, and field qualifiers. It finds records; it never decides two records are the same one.
- `limit` integer: How many to return. The page bound is published in the schema call, and asking for more is refused rather than quietly truncated.
- `types` string: Which object types to search. Absent means all of them, including the types this workspace defined itself.

## Response `200`

Success

- object
  - `results` object[], required
    - `type` string, required
    - `id` string, required
    - `title` string, required
    - `subtitle` string, required
    - `matchedText` string
    - `score` integer, required
  - `truncated` boolean
  - `requestId` string, required

## Other responses

- `401`: No credential, or one that has been revoked.
- `403`: Authenticated, and this capability is not held.
- `422`: The request does not satisfy the schema on this page.
- `429`: Infrastructure protection tripped. This is not a product quota.
- `500`: A defect on our side. The hint says so, and carries an incident id.

---

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