> ## Documentation Index
> Fetch the complete documentation index at: https://docs.linquid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Search API

> Workspace-scoped global search across campaigns, links, and rules

# Search API

Search powers the dashboard command palette and global search input.

## Endpoint

* `GET /api/search`

## Query parameters

<ParamField query="q" type="string" required>
  Search text. Empty value returns empty arrays.
</ParamField>

<ParamField query="limit" type="number" default="5">
  Per-section max results (`1..20`).
</ParamField>

## Access

* Permission: `links:read`
* Workspace scoped

## Matching behavior

* Campaigns: `name`, `description`
* Links: `shortCode`, `title`, `destinationUrl`
* Rules: `name`, `description`
* Case-insensitive partial matching
* Soft-deleted rows are excluded

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.linquid.io/api/search?q=summer&limit=8" \
    -H "Authorization: Bearer <token>"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "success": true,
    "data": {
      "campaigns": [{ "id": "campaign_1", "name": "Summer Sale" }],
      "links": [{ "id": "link_1", "shortCode": "summer24" }],
      "rules": [{ "id": "rule_1", "name": "US mobile" }]
    }
  }
  ```
</ResponseExample>