Search

GET /search

Search entities

This endpoint allows searching for entities in the Foundry world based on a query string. Search world entities and compendiums using the native built-in search engine. No third-party modules required. Results are ranked by relevance: exact match, prefix match, substring match, word-prefix match, and subsequence match.

Required scope: search

Parameters

Name	Type	Required	Source	Description
clientId	string		query	Client ID for the Foundry world
query	string		query	Search query string (omit to browse all entities matching filter)
filter	string		query	Filter string — simple: filter="Actor"; compound: filter="documentType:Item,subType:weapon". Supported keys: documentType, subType, folder, package, resultType
excludeCompendiums	boolean		query	Exclude compendium entries from results (default: false — compendiums are included by default)
limit	number		query	Maximum number of results to return (default: 200, max: 500)
minified	boolean		query	Return minimal fields only — uuid, id, name, img, documentType (default: false)
ownedByUserId	string		query	Filter results to only documents the specified Foundry user (ID or username) has Owner permission on
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Search results containing matching entities

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3011';
const path = '/search';
const params = {
  clientId: 'qsl-integration-test',
  filter: 'documentType:Actor',
  excludeCompendiums: 'true'
};
const queryString = new URLSearchParams(params).toString();
const url = `${baseUrl}${path}?${queryString}`;

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'x-api-key': 'your-api-key-here'
  }
});
const data = await response.json();
console.log(data);

cURL

curl -X GET 'http://localhost:3011/search?clientId=qsl-integration-test&filter=documentType%3AActor&excludeCompendiums=true' \
  -H "x-api-key: your-api-key-here"

Python

import requests

base_url = 'http://localhost:3011'
path = '/search'
params = {
    'clientId': 'qsl-integration-test',
    'filter': 'documentType:Actor',
    'excludeCompendiums': 'true'
}
url = f'{base_url}{path}'

response = requests.get(
    url,
    params=params,
    headers={
        'x-api-key': 'your-api-key-here'
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3011';
  const path = '/search';
  const params = {
    clientId: 'qsl-integration-test',
    filter: 'documentType:Actor',
    excludeCompendiums: 'true'
  };
  const queryString = new URLSearchParams(params).toString();
  const url = `${baseUrl}${path}?${queryString}`;

  const response = await axios({
    method: 'get',
    headers: {
      'x-api-key': 'your-api-key-here'
    },
    url
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3011 ➡️ port
  🔤/search🔤 ➡️ path

  💭 Query parameters
  🔤clientId=qsl-integration-test🔤 ➡️ clientId
  🔤filter=documentType:Actor🔤 ➡️ filter
  🔤excludeCompendiums=true🔤 ➡️ excludeCompendiums
  🔤?🧲clientId🧲&🧲filter🧲&🧲excludeCompendiums🧲🔤 ➡️ queryString

  💭 Build HTTP request
  🔤GET /search🧲queryString🧲 HTTP/1.1❌r❌nHost: localhost:3011❌r❌nx-api-key: your-api-key-here❌r❌n❌r❌n🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "type": "search-result",
  "requestId": "search_1782956918505",
  "filter": "documentType:Actor",
  "results": [
    0: {
      "documentType": "Actor",
      "folder": null,
      "id": "w8wIGpE73y2AYrCo",
      "name": "test-perrin (halfling monk)",
      "package": null,
      "packageName": null,
      "subType": "character",
      "uuid": "Actor.w8wIGpE73y2AYrCo",
      "icon": "systems/dnd5e/tokens/heroes/MonkStaff.webp",
      "journalLink": "@UUID[Actor.w8wIGpE73y2AYrCo]{test-perrin (halfling monk)}",
      "tagline": "Actors Directory",
      "formattedMatch": "test-perrin (halfling monk)",
      "resultType": "WorldEntity"
    },
    1: {
      "documentType": "Actor",
      "folder": null,
      "id": "V5OF1QXHjaIy6iO8",
      "name": "Updated Test Actor",
      "package": null,
      "packageName": null,
      "subType": "character",
      "uuid": "Actor.V5OF1QXHjaIy6iO8",
      "icon": "systems/dnd5e/tokens/heroes/MonkStaff.webp",
      "journalLink": "@UUID[Actor.V5OF1QXHjaIy6iO8]{Updated Test Actor}",
      "tagline": "Actors Directory",
      "formattedMatch": "Updated Test Actor",
      "resultType": "WorldEntity"
    }
  ]
}