---
title: "Get contacts autocomplete suggestions"
method: GET
path: "/api/v2/contacts/autocomplete"
tags: ["Contacts"]
---

# Get contacts autocomplete suggestions

`GET /api/v2/contacts/autocomplete`

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Contacts/getContactsAutocomplete" target="_blank">Try in sandbox</a><br>Get contacts autocomplete suggestions by given search terms.

## Query parameters

- `limit` integer
- `query` string, required
- `lists` 0 | 1

## Response `200`

Autocomplete data has been returned with success.

- GetContactsAutocompleteResponseItem[]
  - `entityId` integer, required — Id of entity. 0 if object is a reply.
  - `entityType` 'reply' | 'contact' | 'list', required — Entry type: * **contact** if it is related to a contact; * **list** if it is related to a contact list; * **reply** if it is related to an incoming message.
  - `value` string, required — ID of the contact/list if entityType is contact/list OR phone number if entityType is reply.
  - `label` string, required — Name of the contact/list if entityType is contact/list OR phone number if entityType is reply.
  - `sharedBy` string, required — If contact or list was shared by another sub-account, the name of this user will be shown.
  - `isShared` boolean, required — If contact or list was shared by another sub-account then `true` will be set.
  - `avatar` string, nullable, required — Contact avatar URI.
  - `favorited` boolean, required — If contact has been marked as favorite.
  - `userId` integer, required — Owner ID of the contact/list (if it was shared).
  - `countryName` string, required
  - `qposition` integer, required
  - `rposition` integer, required

## Other responses

- `401` — Unauthorized request.

---

[API](https://skmtc.net/textmagic/apis/textmagic-api.md) · [All operations](https://skmtc.net/textmagic/apis/textmagic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/textmagic/textmagic-api/revisions/3e4029d19684/schema)