---
title: "Full-text search reports"
method: GET
path: "/reports/search"
tags: ["Reports"]
---

# Full-text search reports

`GET /reports/search`

## Request

- Base URL: `https://commareports.com/api/v1`
- URL: `https://commareports.com/api/v1/reports/search`
- Auth: HTTP bearer

Trigram search across reports the token's owner owns, was invited to, or shares with their team (other people's public share links are not searchable). Scope: `reports:read`.

## Query parameters

- `q` string, required
- `limit` integer
- `include_html` 'true' | '1'

## Response `200`

Ranked matches.

- object
  - `results` SearchResult[], required
    - `id` string, uuid, required
    - `title` string, nullable
    - `description` string, nullable
    - `snippet` string, nullable
    - `similarity` number, required
    - `url` string, uri, required: Absolute public URL.
    - `share_url` string, uri, required: Absolute /p/:id URL.
    - `html` string: Present on the top 3 results when include_html was set.

## Other responses

- `400`: Malformed body or invalid field.
- `401`: Missing, invalid, revoked, or expired token.
- `403`: Token missing the required scope, or no access to the resource.
- `429`: Rate limit exceeded. Rate limit: per-token sliding window (plan-aware — Free 60 req/min, Pro 600, Team/Enterprise 6000 by default); 429 responses carry a Retry-After header.
- `500`: Unexpected server error.

---

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