---
title: "Search across records"
method: GET
path: "/search"
tags: ["Search"]
---

# Search across records

`GET /search`

## Request

- Base URL: `https://app.buildworkpro.com/api/v1`
- URL: `https://app.buildworkpro.com/api/v1/search`
- Auth: HTTP bearer

Full-text and fuzzy search across projects, contacts, site logs, documents, bids, leads, invoices, pay apps and change orders, blended into one relevance-ranked list. Requires `projects:read`; each other type is included only when the credential also holds that type's read scope (e.g. `bids:read`), and results are limited to records the authorizing user may open.

## Query parameters

- `q` string, required: Search text, at least 2 characters. `*` lists recent records.
- `limit` integer: Maximum results (default 20, max 50).

## Response `200`

Matches, best first

- object
  - `data` SearchResult[], required
    - `type` 'project' | 'contact' | 'site_log' | 'document' | 'bid' | 'lead' | 'invoice' | 'pay_app' | 'change_order', required: Entity type of the match.
    - `id` integer, required: Id of the matched record; fetch it from that type's own endpoint.
    - `title` string, required: Display title (name, number or filename).
    - `subtitle` string, nullable, required: Short secondary text — email, project number, or the start of the matched body. Null when there is none.
    - `projectId` integer, nullable: Parent project for change orders, pay apps, site logs and invoices; null when the record has none. Absent for other types.
  - `meta` ResponseMeta, required
    - `request_id` string: Server-generated request identifier
    - `pagination` PaginationMeta
      - `cursor` string, nullable, required: Opaque cursor for the next page; null when no more results
      - `has_more` boolean, required: Whether more pages are available after this one
      - `count` integer, required: Items in this page

## Other responses

- `400`: Error
- `401`: Error
- `403`: Error

---

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