ImportOS · Документація
Довідник API

GET /v1/contacts

List and search contacts

List and search contacts

Cursor-paginated list of the tenant contacts (deleted/anonymized contacts are excluded). Requires scope write:deals.

  • Автентифікація: заголовок Authorization: Bearer rv_live_... (API-ключі та scopes)
  • Потрібний scope: write:deals
Опис операції, параметрів і полів походить зі специфікації OpenAPI (openapi.json) і подається англійською, як у самому API.

Параметри

ПолеДеТипОбов’язк.Опис
qquerystringніSearch by name, phone digits, email or Telegram.
typequerystringніComma-separated: lead,client,partner,supplier,other.
tagquerystringні
owner_user_idquerystring (uuid)ні
unassignedquery"true" | "false"ні
sortquery"createdAt" | "updatedAt" | "fullName"ні
dirquery"asc" | "desc"ні
cursorquerystringніnextCursor from the previous page.
limitqueryintegerні

Відповіді

200

A page of contacts.

application/json · Схема: ContactPage

ПолеТипОбов’язк.Опис
itemsobject[]так
items[].idstring (uuid)ні
items[].type"lead" | "client" | "partner"ні
items[].fullNamestringні
items[].phonesstring[]ніE.164.
items[].emailsstring[]ні
items[].telegramIdstring | nullні
items[].telegramUsernamestring | nullні
items[].viberIdstring | nullні
items[].source"site" | "telegram" | "instagram" | "referral" | "ads" | "manual" | "viber" | "widget" | "extension" | "api" | "import" | "marketplace"ні
items[].ownerUserIdstring | null (uuid)ні
items[].tagsstring[]ні
items[].consentMarketingbooleanні
items[].preferredChannel"telegram" | "viber" | "email" | "sms" | "webhook" | "in_app" | nullні
items[].locale"uk" | "pl" | "en"ні
items[].notesstring | nullні
items[].createdAtstringніISO 8601 date-time (UTC).
items[].updatedAtstringніISO 8601 date-time (UTC).
nextCursorstring | nullтак

400

Invalid request parameters or body (code validation_error).

application/problem+json · Схема: Problem

401

Missing, malformed, unknown, revoked or expired API key (code unauthorized).

application/problem+json · Схема: Problem

403

The API key lacks the scope required by this endpoint (code insufficient_scope).

application/problem+json · Схема: Problem

422

Invalid filter.

application/problem+json · Схема: Problem

429

Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.

application/problem+json · Схема: Problem

На цій сторінці