Search

Overview

The Search API provides endpoints for querying the search index, exporting results, and managing the index itself. The portal API extends this with saved searches and search profiles for personalized search experiences.

Integration Developer Guide

Before diving into the endpoint reference, here are the key concepts you need to know to use search effectively in an integration:

Search Spans All Content Definitions

A search query without filters returns results across all content definitions simultaneously — assets, committee records, meeting records, and everything else in the system. In most integration scenarios, you will want to filter to a specific content type:

{ "fieldName": "contentDefinitionId", "value": "<your-content-def-id>" }

Field Names Come From the Content Definition Designer

The fieldName values used in filters and sortFields must exactly match the property name of the field as configured in the Site Manager content definition designer. The property name is set when creating or editing a field — it becomes the field's permanent key in the search index.

Use GET /admin/search/mappingFieldNames to retrieve all currently indexed field names.

Start With Filters and Sort Fields

For the majority of integration use cases — syncing records, looking up items by external ID, listing content by type — the two most important SearchModel parameters are:

• filters — narrow results to the records you care about
• sortFields — control ordering for consistent pagination

All other parameters (distinct values, AI-based search, deep search) are advanced options for specific use cases.

Use Search for Bulk Lookups

Rather than fetching records one at a time via GET /admin/content/{defId}/{id}, use a single POST /admin/search call with a filter to retrieve many records at once. This is significantly more efficient for sync operations. See Data Synchronization for the recommended pattern.

Base Routes

Searching

Full Search (POST)

POST /admin/search
POST /portal/search
Request body: SearchModel { searchQuery, filters, sortFields, pageSize, pageOffset, ... }
Query: ?includeInternalFieldsInResults=false
Response: ListResultModel<SearchResultModel> { items, totalItemCount }

The POST-based search accepts a full SearchModel in the request body with complete control over filters, sorting, pagination, and field selection.

Simple Search (GET - Admin Only)

GET /admin/search?searchQuery=...&pageSize=...&pageOffset=...&sortField=...&sortOrder=...
Query string parameters override any values in the optional body SearchModel.
Additional query parameters are extracted as filters.
Response: ListResultModel<SearchResultModel>

Get Document by ID

GET /admin/search/{id}
GET /portal/search/{id}
Query: ?includeInternalFieldsInResults=false
Response: SearchResultModel

Retrieves a single document from the search index. In the Portal API, only Asset and Live Channel documents are accessible; other content types return 404.

Exporting

POST /admin/search/export
POST /portal/search/export
Request body: SearchModel
Query: ?background=false
Response: Excel file (XLSX) download, or 204 if no results

Exports search results as an Excel spreadsheet. If no sort fields are specified, results default to sorting by masterId.

When background=true, the export is queued as a batch job and the response returns immediately with 204. The completed file is delivered via email.

Index Management (Admin Only)

Get Field Names

GET /admin/search/mappingFieldNames
Response: string[] (list of indexed field names)

Returns all field names available in the search index schema for use in filters, sorts, and field selection.

Rebuild Index

POST /admin/search/rebuild-index/{type}

Triggers a search index rebuild. Supported types:

Warning: $ALL_CLEAR$ makes search temporarily unavailable during the rebuild.

Saved Searches (Portal)

Saved searches persist search criteria for later re-execution.

Executing Saved Searches

GET /portal/search-saved/{id}?returnedFieldNames=...
Executes the saved search by ID

POST /portal/search-saved
Request body: SavedSearchModel
Executes an ad-hoc saved search model without persisting changes

Both return ListResultModel<SearchResultModel>.

Search Profiles (Portal)

Search profiles store default search configurations such as filters, display columns, and sort preferences.

Common Error Responses