ImportOS · Docs
API reference

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.

  • Authentication: header Authorization: Bearer rv_live_... (API keys and scopes)
  • Required scope: write:deals
Descriptions of the operation, parameters and fields come from the OpenAPI specification (openapi.json).

Parameters

FieldInTypeRequiredDescription
qquerystringnoSearch by name, phone digits, email or Telegram.
typequerystringnoComma-separated: lead,client,partner,supplier,other.
tagquerystringno
owner_user_idquerystring (uuid)no
unassignedquery"true" | "false"no
sortquery"createdAt" | "updatedAt" | "fullName"no
dirquery"asc" | "desc"no
cursorquerystringnonextCursor from the previous page.
limitqueryintegerno

Responses

200

A page of contacts.

application/json · Schema: ContactPage

FieldTypeRequiredDescription
itemsobject[]yes
items[].idstring (uuid)no
items[].type"lead" | "client" | "partner"no
items[].fullNamestringno
items[].phonesstring[]noE.164.
items[].emailsstring[]no
items[].telegramIdstring | nullno
items[].telegramUsernamestring | nullno
items[].viberIdstring | nullno
items[].source"site" | "telegram" | "instagram" | "referral" | "ads" | "manual" | "viber" | "widget" | "extension" | "api" | "import" | "marketplace"no
items[].ownerUserIdstring | null (uuid)no
items[].tagsstring[]no
items[].consentMarketingbooleanno
items[].preferredChannel"telegram" | "viber" | "email" | "sms" | "webhook" | "in_app" | nullno
items[].locale"uk" | "pl" | "en"no
items[].notesstring | nullno
items[].createdAtstringnoISO 8601 date-time (UTC).
items[].updatedAtstringnoISO 8601 date-time (UTC).
nextCursorstring | nullyes

400

Invalid request parameters or body (code validation_error).

application/problem+json · Schema: Problem

401

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

application/problem+json · Schema: Problem

403

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

application/problem+json · Schema: Problem

422

Invalid filter.

application/problem+json · Schema: Problem

429

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

application/problem+json · Schema: Problem

On this page