Search

Get Autocomplete Suggestions

Type-ahead over one field's values.

The counterpart to filter-options for fields whose value set is too large to enumerate - company name and domain especially, where the backend also expands domains (amazon matches amazon.com) and ranks by company score rather than alphabetically.

get/search/autocomplete

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/search/autocomplete
  • Auth: HTTP bearer

Query parameters

resource'contacts' | 'companies' required

Which vocabulary field is in.

fieldstring required

Developer field name to search within.

valuestring required

What the person has typed so far.

sizeinteger

How many suggestions to return.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataSearchDiscoveryPayload required

An open envelope for an autocomplete or filter-option result.

Changes

No recorded changes to this operation across all 2 revisions of this API.