Everything matching q

GET /search

Everything matching q, across the platform, of the kinds the caller's scopes reach (hits and total): inventory items (SKU, name, barcode), products (title, handle, vendor, variant SKUs), purchase orders (number, reference, supplier), orders (number, reference), companies (name, external id) and people (name, email).

Matching is a case-insensitive substring, the same rule every grid's own q applies. All but people answer from the service's own search index — folded from local logical-replication mirrors of the source journals, so a search never reads an operational primary and a hit can be at most a fold interval stale. People are the deliberate exception: names and emails are sealed in the CRM journal (right-to-erasure crypto-shredding), so person hits are fetched live from CRM's GET /parties with the caller's own token, and when CRM cannot answer the response carries peopleUnavailable instead of failing. kinds narrows the search; limit (default 20, capped at 50) applies per source; total counts every match either source reported. The index ranks at most a few hundred candidates per term, the best kind of match first, so a term matching more documents than that counts the ones it ranked and pages the best of those.

Access

Requires stock:read or products:read or purchasing:read or orders:read or catalogs:read or companies:read or customers:read.

Any one of these scopes is enough.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

AI agent tool

Agents call this as search_query (Search: Search everything), in the search toolset. It only reads.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://search.getmanifold.io/search?q=lantern&kinds=item%2Cproduct%2Corder&limit=20' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://search.getmanifold.io/search?q=lantern&kinds=item%2Cproduct%2Corder&limit=20", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "hits": [
    {
      "id": "itm_01a15b1d-32a8-785a-98eb-d43b3ac4c143",
      "kind": "item",
      "title": "LANTERN-BRASS",
      "subtitle": "Brass camp lantern",
      "sku": "LANTERN-BRASS"
    },
    {
      "id": "prd_01a15b54-21aa-71a5-a874-5967972729f4",
      "kind": "product",
      "title": "Brass camp lantern"
    },
    {
      "id": "ord_01a15b8b-10ac-726b-93de-6280ba50afe9",
      "kind": "order",
      "title": "SO-01042",
      "subtitle": "Hollowbrook Supply Co."
    }
  ],
  "total": 3
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: search-manager.openapi.json. Base URL https://search.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`409`

Refusal	What it means	What to do
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Try again shortly.

How refusals work everywhere: Errors.