List Valid Filter Terms
smithsonian_list_termsEnumerate the valid term vocabulary for an indexed Smithsonian filter field (unit_code, culture, place, date, online_media_type, topic). Terms are a controlled vocabulary — often plural or qualified (e.g. "Paintings", not "Painting") — so guessed filter values tend to return nothing. Returns a page of the field's distinct term values; large vocabularies (topic has 133k terms, place 114k) page via start and rows. For unit_code, each code is returned with its museum name and contains matches the name as well as the code, so a museum name resolves to its code in one call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | Number of terms to return per page (default 50, max 100). | |
| field | Yes | Indexed field to enumerate. Choices: unit_code (museum codes like "NASM"), culture (e.g. "Aztecs"), place (geographic terms), date (decade/era values like "1920s"), online_media_type (media formats like "Images", "3D Models"), topic (subject terms like "Quilts" — 133k terms, so pair it with contains). | |
| start | No | Pagination offset (0-indexed). Use with rows to page through large vocabularies. | |
| contains | No | Case-insensitive substring filter on the term vocabulary — resolve a filter value (e.g. "greek") to its exact controlled-vocabulary term(s). For unit_code the substring also matches each code's museum name, so "National Air and Space" resolves to "NASM". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The rows cap that was applied. | |
| error | No | Present when the call failed. Absent on success. | |
| field | No | The enumerated field, as provided in the request. | |
| shown | No | Number of terms returned in this page. | |
| terms | No | The field's distinct term values for this page, in the Smithsonian index's native order. No per-term object counts are available upstream. | |
| total | No | Total number of distinct terms for this field (the full vocabulary size; terms is one page of it). | |
| labels | No | Museum name for each unit_code on this page that has one — present only when field is "unit_code". A few rarely-indexed archive sub-unit codes have no mapped name and are absent from this map; their term is still returned in terms. | |
| notice | No | Guidance naming the input that retrieves the terms this page omitted, or how to broaden a contains filter that matched nothing. | |
| truncated | No | True when matching terms remain past this page. False on a terminal or past-the-end page, where nothing is being withheld. | |
| truncationCeiling | No | Distinct terms available for this query (the full vocabulary, or the contains-match count) — upper bound for omitted items. |