Skip to content

Get Autocomplete Suggestions

GET
/search/autocomplete

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.

Authorizations

Parameters

Query Parameters

resource
required

Which vocabulary field is in.

string
Allowed values: contacts companies

Which vocabulary field is in.

field
required

Developer field name to search within.

string

Developer field name to search within.

value
required

What the person has typed so far.

string

What the person has typed so far.

size

How many suggestions to return.

integer
default: 5 >= 1 <= 20

How many suggestions to return.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

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

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string