Search a vault
Search the records of one of your vaults, or of all of them, for every word you type.
A record is found when it holds every word, in any order, in its name, in any value written on it, or in the name of somebody linked to it: who took part in a life event, or who a contact has a relationship with. Case and accents are ignored, and a typing mistake is tolerated.
Results come in groups, the way the product lists them: people, each entity type, then life events. Within a group, a record whose name holds the words comes before one where they are only in its values, and that one before a record found only through somebody linked to it.
A value of a field marked sensitive is searched only with a key holding the sensitive-fields scope. Any other key never finds a record through such a value.
Search needs the search engine of the instance. While it cannot be reached, the endpoint answers 503 and nothing else is affected.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault to search, named either by the readable name it reports as slug or by its id. Both answer.
The words to find, at least two characters and at most 255.
vault to search the vault named in the path, account to search every vault of the account.
One group only, by the key a previous answer gave it, to page through it.
The page of the group asked for.
How many results per group, at most 100.
Returns
The groups of records found. A vault belonging to somebody else answers 404, a query under two characters 422, and an unreachable search engine 503.
The groups holding at least one result, in the order the product shows them.
One group.
The key of the group: people, life-events, or entity-type- followed by the entity type.
The name of the group, in the language of the account.
How many records the group holds in all.
The page to ask for next, with group, or null on the last page.
The records of the group on this page, best match first.
One record.
contact, entity or life_event.
The id the record answers to on its own endpoints.
The name the record is listed under.
The vault the record lives in.
The id of the vault.
The name of the vault.
Whether the record is archived.
For a life event, the day it happened, else null.
Where the words were found: the label of the value and its text, or null when the name holds them. The text of a sensitive value is always null.
The label of the value, or of the link, the words were found in.
The text of that value, or null for a sensitive value or a link.
What was asked.
The words searched.
vault or account.
Rate limit
Sixty requests per minute, per token. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.