---
title: "Search everything grape.cool publishes"
method: GET
path: "/search"
tags: ["Search"]
---

# Search everything grape.cool publishes

`GET /search`

## Request

- Base URL: `https://grape.cool/api/v1`
- URL: `https://grape.cool/api/v1/search`
- Auth: none required

Matches a term against help articles, blog posts, features, product areas, audiences and questions in one call, and returns the hits with a URL for each. Use this first when you do not know which endpoint holds the answer.

## Query parameters

- `q` string, required
- `limit` integer

## Response `200`

Matching entries, best match first.

- object
  - `success` true, required
  - `data` SearchResult[], required
    - `type` 'help-article' | 'blog-post' | 'feature' | 'product' | 'solution' | 'faq', required: Which endpoint the hit came from.
    - `title` string, required: Title of the matching entry.
    - `description` string, required: Summary of the entry.
    - `url` string, uri, required
    - `score` integer: Two for a title match, one for a body match.
  - `meta` Meta: Counts and echoed arguments that describe the payload.
    - `total` integer: How many items exist.
    - `returned` integer: How many items this response carries.
    - `query` string: The search term that was used.
    - `currency` string: ISO 4217 code the prices are quoted in.

## Other responses

- `400`: A parameter was missing or outside the allowed values.
- `404`: Nothing matches the identifier given.
- `429`: More than 1000 requests came from this IP address in an hour.
- `500`: The request could not be completed.

---

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