Browse the tools
Available tools
Search
Search finds the people, other records and life events of one vault, or of every vault of your account, from a few words.
Choose a tool to see the parameters it accepts.
Tools
Search the people, entities and life events of a vault, or of every vault, for every word given, typing mistakes tolerated. The results come back in result groups, one per kind of record.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
querystringrequired - The words to find, at least two characters.
-
scopestringoptional -
vault to search that vault, account to search every vault of the account. vault when left out.
One of:
vault,account -
groupstringoptional - One result group only, by the key an earlier answer of search-records gave it.
-
pageintegeroptional - The page of each result group to read, starting at 1.
-
per_pageintegeroptional - How many results a result group holds per page: 25 unless asked, 100 at most.