FAfamilysearch
Vocabularies

Search Controlled Vocabulary Terms

The Controlled Vocabulary Concepts Search resource defines the set Controlled Vocabulary terms associated with a list of Controlled Vocabulary Concepts that match a set of search criteria.

The scope of the terms returned can be limited by using the type query parameter.

The search query (q parameter) must contain at least one string or one attr.

A string in the search query will search for all concepts with that string in its description or gedcomxUri (example: q=string:"some description"). The given string can match anywhere in the description and is case insensitive. A given string of "Male" will match "Female", "Male", and "Male Cousin".

An attr in the search query will search for all concepts with that attribute with that value (example q=attr.12:"value1").

It is also possible to redact an attr by placing a dash (-) in front of attr. A redacted attr in the search query will not return any all concepts with that attribute with that value (example q=-attr.17:"value2").

An attr is separated into two parts. The attribute id follows a period and must come first. The attribute value follows the colon and must be surrounded by double quotes. The search on attribute values returns only exact matches, however it is case insensitive. It is possible to leave off either the attribute id or the attribute value. The search will simply match on what it is given. It is possible to send multiple attrs. The search will return only concepts that have all of the supplied attributes.

Valid Query String Examples

Query SyntaxResult
q=string:"some description"Concepts whose description or gedcomxUri contains that text (case-insensitive substring match)
q=attr.<id>:"<value>"Concepts having attribute <id> equal to <value> (case-insensitive exact match)
q=-attr.<id>:"<value>"Excludes concepts having that attribute value
q=string:"desc" attr.1:"v1" attr.2:"v2"Combine clauses with spaces; all must match

See <a href="https://developers.familysearch.org/main/docs/vocabulary-concepts-search" target="_blank">Vocabulary Concepts Search (Guide)</a> for detailed usage examples and filtering tips, including the full list of attribute IDs and term types.

get/vocab/concepts/search

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/vocab/concepts/search
  • Auth
    HTTP bearer

Query parameters

qstring required

The search query. See <a href="https://developers.familysearch.org/main/docs/controlled-vocabulary-search#searching-with-q" target="_blank">Vocabulary Concepts Search (Guide)</a> for detailed usage examples and filtering tips, including the full list of attribute IDs

startinteger required

The 0 based index of the first search result in this page of results.

countinteger required

The maximum number of search results to return in this page of results.

typestring

For each concept found, a list of terms will be returned. Use this parameter to limit what types of terms are returned. Accepts a comma delimited list of termTypes to match against. Commonly referenced term types include OFFICIAL, OFFICIAL_PLURAL, ABBREVIATION, ALTERNATE, and CODE. See <a href="https://developers.familysearch.org/main/docs/controlled-vocabulary-search#filtering-by-term-type" target="_blank">Vocabulary Concepts Search (Guide)</a> for full list of term types.

Headers

Accept'application/x-gedcomx-atom+json' | 'application/json' | 'application/atom+xml' | 'application/xml' required

Specifies the media type(s) that the client is willing to accept in the response.

Response

Concepts were found that match the given search criteria.

Changes

No recorded changes to this operation across all 1 revision of this API.