---
title: "Search the catalog"
method: GET
path: "/search.json"
tags: ["Discovery"]
---

# Search the catalog

`GET /search.json`

## Request

- Base URL: `https://listme.name/api/v1`
- URL: `https://listme.name/api/v1/search.json`
- Auth: none required

Searches lists, products, books, categories and articles by name and description.

## Query parameters

- `q` string, required
- `type` 'product' | 'list' | 'category' | 'article'
- `limit` integer

## Response `200`

Search the catalog

- SearchResults
  - `query` string, required
  - `count` integer
  - `results` object[], required
    - `type` 'product' | 'list' | 'category' | 'article'
    - `name` string
    - `slug` string
    - `hint` string
    - `page` string, uri
    - `json` string, uri

## Other responses

- `400`: The request was invalid or the item does not exist.
- `404`: The request was invalid or the item does not exist.

---

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