Search
Full-text search
Perform full-text search across collections in a project. Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). Both ProjectBearerAuth and ApiKeyAuth are fully implemented.
GET
/api/search/projects/{projectId}/searchSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, SearchApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const search = new SearchApi(configuration);import { Configuration, SearchApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const search = new SearchApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await search.searchData("proj_LrFJFbeKTriO");const { data: result } = await search.searchData("proj_LrFJFbeKTriO");Playground
liveTest 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
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | — |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
q | string | Yes | — |
collections | string | No | — |
fields | string | No | — |
limit | integer | No | — |
page | integer | No | — |
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
}
}