Autocomplete search
Type-ahead search across people, organizations, groups, and orders, returning weighted autocomplete results suitable for type-ahead widgets. Results are policy-scoped.
Authorization
bearerAuth In: header
Query Parameters
The partial search term to match against.
Restrict and scope the search. filter[resource_type] limits the
record types searched (allowed: people, organizations, groups,
orders); it accepts a comma-separated string or repeated keys.
filter[people], filter[organizations], filter[groups], and
filter[orders] carry per-type where-clauses passed through to the
search backend.
Pagination. page[size] caps the total number of weighted results (max 100, default 20).
Comma-separated list of related resources to include. Allowed values:
resource, resource.address, resource.addresses,
resource.emails, resource.phones, resource.web_addresses,
resource.child_organizations. resource is always included.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/search/autocomplete?include=resource%2Cresource.emails"{ "data": [ { "type": "autocomplete_results", "id": "string", "attributes": { "id": "string", "score": 0 }, "relationships": { "resource": { "data": { "type": "people", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } } }, "links": { "self": "../dictionary" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}