Skip to content

Search

Full-text search across one or more buckets. See Filtering & Search for when to use this versus the filter parameter on list endpoints.

GET /v1/search?q=hello&bucket=my-first-bucket
Response
{
  "data": [
    {
      "bucket": "my-first-bucket",
      "name": "hello-world",
      "score": 0.92,
      "highlight": "<em>hello</em>-world"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Query parameters

Parameter Required Description
q Yes Search query string
bucket No Restrict results to a single bucket
limit No Page size, see Pagination

Indexing delay

New and updated records typically become searchable within a few seconds. If you need immediate consistency, query the Buckets & Records endpoint directly instead.