Searches the structures of a single type in your organization, ordered by relevance. structure_type is required — pass a built-in type such as SYSTEM_STRUCTURE_TYPE_SITE or an org-defined structure type UUID. Results are paginated with page_token.
Use this endpoint to resolve a structure by name, to browse a type, or to find the structures whose field values match a set of criteria. Results are returned ordered by relevance.
structure_type is required and scopes every search to a single type. Identify the type either by a built-in value SYSTEM_STRUCTURE_TYPE_SITE or SYSTEM_STRUCTURE_TYPE_GROUP, or by the UUID of a type your organization has defined. To search across several types, issue one request per type.
Leave params.query empty to list a type rather than search it.
Requirements
Narrow the result set with params.filters:
structure_uuidsrestricts results to specific structures.field_valuesrestricts results to structures whose field values match. Values within one filter are OR-combined; separate filters are AND-combined.
Set params.include_fields to return each result with its fully-populated field values, and params.include_matches to return the field values that matched the query, which is useful for highlighting.
Page through results with params.page.page_size and params.page.page_token. total_count is accurate up to 10,000 results; beyond that, treat a value of 10000 as "10,000 or more".
Results are restricted to the structures the calling token can already see. Filters narrow that set.