v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB

Entities

autocomplete

Autocomplete entity attributes

get/v1/entity:autocomplete

Query parameters

anonymizeboolean

When true, anonymizes PII in the response: identifiers (names, emails, phone numbers, IBANs) are replaced with deterministic pseudonyms (stable within an org), addresses are generalized to postal code / city / country, and well-known free-text fields (e.g. note content) are redacted.

Useful for AI agents and data analysis use cases that must not access personal data.

Anonymization is forced (regardless of this parameter) when the access token was created with anonymize: true.

inputstring

Input to autocomplete

attributestring required

Example:_tags

Autocomplete attribute

slugstring

URL-friendly identifier for the entity schema

Example:contact

Limit results to entity schema

sizeinteger

Maximum number of results to return

Response

Success

hitsnumber

Example response

{
  "hits": 1,
  "results": [
    "value"
  ]
}