Get

[POST] .../v1/client/get

Returns CRM clients with filters and pagination. Use this method to find CRM clients for operator workspaces, client cards, deduplication, ticket/lead/deal linking and customer sentiment review. The response returns paged Client records with next_offset and total, including contact identifiers, responsible user, sentiment aggregates, deletion flag, creator, last update time and custom field values when the tariff allows additional fields. The request body is required and supports filters, limit, offset and ids, phones, external_ids, emails, search and responsible_user_ids fields; filters can target built-in client fields and enabled custom fields. The caller must have CRM client select permission; missing body, denied access, invalid filters, unsupported sentiment filters on older database versions, disabled additional fields, database errors and persistent lookup errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Requested item count. Default is 100.
offset Int32 Optional Pagination offset. Default is 0.
search String Optional Search by name, phone, email or external_id.

Filterable Fields

Field Type Description
email string
emails string Filter by email addresses.
external_id string Filter by external IDs.
id int Filter by client IDs.
name string
phone string
phones string Filter by phone numbers.
responsible_user_id int Filter by responsible user IDs.
sentiment_score_avg decimal
sentiment_score_count int
sentiment_score_rolling_avg decimal

Request Example

{
  "filters": [
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "Petrov"
    },
    {
      "Field": "responsible_user_id",
      "Operator": "Equal",
      "Value": "17"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Client Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 125,
      "external_id": "crm-125",
      "name": "Ivan Petrov",
      "phone": "\u002B998901112233",
      "email": "ivan.petrov@example.com",
      "photo_url": null,
      "description": "Returning customer",
      "responsible_user_id": 17,
      "sentiment_score_avg": 4.35,
      "sentiment_score_count": 12,
      "sentiment_score_rolling_avg": 4.70,
      "deleted": false,
      "created_user_id": 3,
      "last_update": 1712345600,
      "fields": []
    }
  ],
  "next_offset": 0,
  "total": 1
}