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
| Field | In | Type | Required | Description |
|---|---|---|---|---|
q | query | string | no | Search by name, phone digits, email or Telegram. |
type | query | string | no | Comma-separated: lead,client,partner,supplier,other. |
tag | query | string | no | |
owner_user_id | query | string (uuid) | no | |
unassigned | query | "true" | "false" | no | |
sort | query | "createdAt" | "updatedAt" | "fullName" | no | |
dir | query | "asc" | "desc" | no | |
cursor | query | string | no | nextCursor from the previous page. |
limit | query | integer | no |
Responses
200
A page of contacts.
application/json · Schema: ContactPage
| Field | Type | Required | Description |
|---|---|---|---|
items | object[] | yes | |
items[].id | string (uuid) | no | |
items[].type | "lead" | "client" | "partner" | no | |
items[].fullName | string | no | |
items[].phones | string[] | no | E.164. |
items[].emails | string[] | no | |
items[].telegramId | string | null | no | |
items[].telegramUsername | string | null | no | |
items[].viberId | string | null | no | |
items[].source | "site" | "telegram" | "instagram" | "referral" | "ads" | "manual" | "viber" | "widget" | "extension" | "api" | "import" | "marketplace" | no | |
items[].ownerUserId | string | null (uuid) | no | |
items[].tags | string[] | no | |
items[].consentMarketing | boolean | no | |
items[].preferredChannel | "telegram" | "viber" | "email" | "sms" | "webhook" | "in_app" | null | no | |
items[].locale | "uk" | "pl" | "en" | no | |
items[].notes | string | null | no | |
items[].createdAt | string | no | ISO 8601 date-time (UTC). |
items[].updatedAt | string | no | ISO 8601 date-time (UTC). |
nextCursor | string | null | yes |
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