search

Full-text search

Perform full-text search across collections in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

GET/api/search/projects/{projectId}/search

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYesProject ID (MongoDB ObjectId) to search within.

Query Parameters

NameTypeRequiredDescription
qstringYesFull-text search query string.
collectionsstringNoComma-separated collection slugs or IDs to limit search scope.
fieldsstringNoComma-separated field names to search or return in highlights.
limitintegerNoMaximum number of results to return per page.
pageintegerNoPage number for pagination (1-based).

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.search.search({
  projectId: "proj_6Gyu18z1unRo"
});
const result = await client.search.search({
  projectId: "proj_6Gyu18z1unRo"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Responses

200Search results
json
{
  "success": true,
  "data": {
    "results": [
      {
        "collection": "users",
        "item": {
          "_id": "685ae1210136e73fa1dcaf36",
          "email": "john.doe@mudbase.dev",
          "firstName": "John",
          "lastName": "Doe",
          "role": "developer",
          "score": 0.95
        },
        "highlight": {
          "firstName": "<em>John</em>",
          "lastName": "Doe"
        }
      },
      {
        "collection": "users",
        "item": {
          "_id": "685ae1210136e73fa1dcaf37",
          "email": "jane.smith@mudbase.dev",
          "firstName": "Jane",
          "lastName": "Smith",
          "role": "admin",
          "score": 0.82
        },
        "highlight": {
          "firstName": "Jane",
          "lastName": "Smith"
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 2,
      "totalPages": 1
    },
    "query": "john",
    "searchTime": 45
  }
}
{
  "success": true,
  "data": {
    "results": [
      {
        "collection": "users",
        "item": {
          "_id": "685ae1210136e73fa1dcaf36",
          "email": "john.doe@mudbase.dev",
          "firstName": "John",
          "lastName": "Doe",
          "role": "developer",
          "score": 0.95
        },
        "highlight": {
          "firstName": "<em>John</em>",
          "lastName": "Doe"
        }
      },
      {
        "collection": "users",
        "item": {
          "_id": "685ae1210136e73fa1dcaf37",
          "email": "jane.smith@mudbase.dev",
          "firstName": "Jane",
          "lastName": "Smith",
          "role": "admin",
          "score": 0.82
        },
        "highlight": {
          "firstName": "Jane",
          "lastName": "Smith"
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 2,
      "totalPages": 1
    },
    "query": "john",
    "searchTime": 45
  }
}
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Errors

CodeMeaning
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Next steps

Edit this page on GitHub