Skip to main content

​
Search API

Search powers the dashboard command palette and global search input.

​
Endpoint

  • GET /api/search

​
Query parameters

​
q
string
required
Search text. Empty value returns empty arrays.
​
limit
number
default:"5"
Per-section max results (1..20).

​
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
curl -X GET "https://api.linquid.io/api/search?q=summer&limit=8" \
  -H "Authorization: Bearer <token>"

{
  "success": true,
  "data": {
    "campaigns": [{ "id": "campaign_1", "name": "Summer Sale" }],
    "links": [{ "id": "link_1", "shortCode": "summer24" }],
    "rules": [{ "id": "rule_1", "name": "US mobile" }]
  }
}