---
title: "Term Search"
canonical: "https://support.soutron.net/space/LMSAPI/19693579/Term%20Search"
format: markdown
---
## <span style="color: #008000">GET /thesauruses/{Thesaurus}/Terms/Search</span>

<span style="color: #000000">**Description**</span>**:** <span style="color: #172b4d">Search terms within specific Thesauri</span>

| Parameter | Example | Notes |
| --- | --- | --- |
| thesaurus [REQUIRED] | 23 | ID of thesaurus to return |
| query [REQUIRED] |  | Search string for required term |
| lang | lang=2057 | Language name or LCID code to use to search records and return language dependent data in the data records. |
| office | office=1 | Office name or ID to use for search data (affects search permission) |
| portal | portal=1 | Portal name or ID to use for search data (affects search permission) |
| term-id | term-id=1432 | Search will be limited to child terms of specified term-id |
| include-folders | include-folders=1 | Option to include or exclude folders in returned term list.<br>Possible values:<br>1= Include<br>0= Exclude (default) |
| view-mode | view-mode=2 | Option to decide how terms should be returned.<br>Possible values:<br>1= Alphabet view (A-Z)<br>2= Hierarchy<br>3. Plain List<br>Default value is based on default for thesaurus being queries, see [DefaultViewMode](https://soutron.atlassian.net/wiki/spaces/LMSAPI/pages/19693569) |

<span style="color: #000000">**Example**</span>**: /**SoutronAPI/thesauruses/**35**/Terms/Search?**query**=planning&**lang**=2057&**office**=1&**portal**=1&**include-folders**=1&**view-mode**=Hierarchy&**term-id**=78901

##### **Response**

```xml
<ThesaurusSearchTermsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Thesauruses">
	<Letters i:nil="true"/>
	<Terms>
		<ThesaurusSearchResultTermItem>
			<ChildTerms>
				<ThesaurusSearchResultTermItem>
					<ChildTerms/>
					<FoundInLCID>2057</FoundInLCID>
					<HasChild>false</HasChild>
					<MatchedType>MatchByText</MatchedType>
					<NonPreferredTermText i:nil="true"/>
					<ParentTermId>78901</ParentTermId>
					<ScopeNote i:nil="true"/>
					<TermId>78905</TermId>
					<TermStatus>Provisional</TermStatus>
					<TermText>Integrated financial planning (CF5)</TermText>
					<TermType>Preferred</TermType>
					<Url i:nil="true"/>
					<UseCount>0</UseCount>
				</ThesaurusSearchResultTermItem>
				<ThesaurusSearchResultTermItem>
					<ChildTerms/>
					<FoundInLCID>2057</FoundInLCID>
					<HasChild>false</HasChild>
					<MatchedType>MatchByText</MatchedType>
					<NonPreferredTermText i:nil="true"/>
					<ParentTermId>78901</ParentTermId>
					<ScopeNote i:nil="true"/>
					<TermId>78904</TermId>
					<TermStatus>Provisional</TermStatus>
					<TermText>Retirement planning (CF4)</TermText>
					<TermType>Preferred</TermType>
					<Url i:nil="true"/>
					<UseCount>0</UseCount>
				</ThesaurusSearchResultTermItem>
			</ChildTerms>
			<FoundInLCID i:nil="true"/>
			<HasChild>true</HasChild>
			<MatchedType>TraverseTreeUp</MatchedType>
			<NonPreferredTermText i:nil="true"/>
			<ParentTermId i:nil="true"/>
			<ScopeNote i:nil="true"/>
			<TermId>78901</TermId>
			<TermStatus>Provisional</TermStatus>
			<TermText>Certificate in Financial Planning</TermText>
			<TermType>Preferred</TermType>
			<Url i:nil="true"/>
			<UseCount>0</UseCount>
		</ThesaurusSearchResultTermItem>
	</Terms>
</ThesaurusSearchTermsResponse>
```