# contacts.suggest

Suggest contacts.

Compose-screen autocomplete: matches what the user typed (case-insensitive substring) against each card's formatted name, email and structured name, across every addressbook the identity owns plus those shared with it, in one call. Results are deduplicated by address, prefix matches rank first, and the caller's own books rank ahead of shared ones. Cards with no email are excluded (a suggestion a composer cannot address is noise), and only a card's FIRST `EMAIL` is indexed, so a match on a secondary address is not found. Each row carries enough identity (ownerIdentityId + addressbookId + uid) to fetch the full card via the owning addressbook's objects listing with `?uid=`.

```ts
openemail.contacts.suggest(
  identityId: string,
  options: ContactsSuggestOptions,
): ApiPromise<ContactSuggestions>
```

It calls `GET /identities/{identityId}/contacts/suggest`: [Suggest contacts](/docs/api/pim/get_ContactSuggest) in the API reference.

## Example

```ts
const contactSuggestions = await openemail.contacts.suggest(identityId, { q: '…' })
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Mailbox identity ULID. The path's `{identityId}`. |

## Options

The last argument, `options`, takes:

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `q` | `string` | query `q` | Required. What the user typed so far (bounded like every contact search: 48 bytes) |
| `limit` | `number` | query `limit` | Maximum suggestions (default 10) |

Every call also takes `signal`, `timeout`, `retry` and `headers`, which say how that one call is sent ([call options](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`ContactSuggestions`](/docs/sdks/typescript/types/contact-suggestions). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `400` | search_term_too_long: q exceeds the 48-byte search bound |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Identity not found or not accessible to this principal |
| `503` | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

It names these types of the API, each on a page of its own: [`ContactSuggestions`](/docs/sdks/typescript/types/contact-suggestions).
