---
title: "Get Autocomplete Suggestions"
method: GET
path: "/search/autocomplete"
tags: ["Search"]
---

# Get Autocomplete Suggestions

`GET /search/autocomplete`

## Request

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

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.

## Query parameters

- `resource` 'contacts' | 'companies', required: Which vocabulary `field` is in.
- `field` string, required: Developer field name to search within.
- `value` string, required: What the person has typed so far.
- `size` integer: How many suggestions to return.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseSearchDiscoveryPayload
  - `data` SearchDiscoveryPayload, required: An open envelope for an autocomplete or filter-option result.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)