Метод для получения списка контактов вашей компании по заданным параметрам.
Запрос
|
|||
---|---|---|---|
filter[{field}][{operator}] | string | Составной параметр условия выборки (допускается наличие нескольких подобных параметров в запросе). Условие состоит из поля, оператора и значения (значение требуется не для всех операторах).Доступные поля ({field}): client_number (номер контакта в базе), created_at (дата и время создания контакта ISO-8601 UTC+0 в формате YYYY-MM-DDThh:mm:ss.sssZ), full_name (полное имя), phone (телефон), email (электронная почта), organization_id (идентификатор организации), address (адрес), additional (дополнительно), list_tag (название списка), owner_id (идентификатор создателя контакта), custom_property_id (идентификатор любого дополнительного поля контакта).Доступные операторы ({operator}): eq (равно), not_eq (не равно), contains (содержит), not_contains (не содержит), empty (пусто, не требует значения), not_empty (не пусто, не требует значения), gt (больше), lt (меньше).Перечисленные операторы доступны не для всех полей. Соответствие полей и доступных операторов вы можете посмотреть в специальном списке ниже. | |
union | string | Оператор, которым будут объединены все условия запроса: по умолчанию and (объединяя условия оператором «и» вы уменьшаете выборку - будут выбраны только те контакты, которые соответствуют каждому условию) или or (объединяя условия оператором «или» вы увеличиваете выборку - будут выбраны все контакты, которые соответствуют хотя бы одному из условий). | |
sort[{field}] | string | Составной параметр сортировки сущностей выборки. Варианты значений: по умолчанию desc (по убыванию) или asc (по возрастанию).На данный момент сортировка доступна только по полю ({field}) id (идентификатор контакта). | |
per | integer | Количество возвращаемых сущностей за один запрос (по умолчанию 25, максимум 200) | |
page | integer | Страница выборки (по умолчанию 1) | |
Ответ
|
|||
data | array of objects | Массив списка найденных контактов | |
id | integer | Идентификатор созданного контакта | |
client_number | integer | Номер контакта в базе | |
full_name | string | Полное имя | |
owner_id | integer | Идентификатор сотрудника, создавшего контакт | |
created_at | string | Дата и время создания контакта (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ | |
phones | array of strings | Массив телефонных номеров | |
emails | array of strings | Массив электронных адресов | |
address | string | Адрес | |
organization_id | integer | Идентификатор организации, привязанной к контакту | |
additional | string | Дополнительно | |
list_tags | array of strings | Массив списков, привязанных к контакту | |
custom_properties | array of objects | Дополнительные поля контакта | |
id | integer | Идентификатор поля | |
name | string | Название поля | |
data_type | string | Тип поля (string, number, date или link) | |
value | string | Значение | |
Возможные ошибки запроса (errors code)
|
|||
too_long | Слишком длинное значение (пояснения вы получите в поле message) | ||
invalid | Параметр не соответствует правилам (пояснения вы получите в поле message) | ||
not_found | Не удалось найти | ||
invalid | Параметр имеет неверный формат (идентификатор параметра вы получите в поле payload) |
{
"data":
[
{
"id": 3611,
"client_number": "00003",
"owner_id": 226,
"created_at": "2020-04-23T11:32:17.000Z",
"full_name": "Ivan Petrov",
"phones": [],
"emails": [],
"address": "4312 Mount Olive Road",
"organization_id": null,
"additional": "fake data",
"list_tags": [],
"custom_properties": [
{
"id": 1021,
"name": "Car",
"data_type": "string",
"value": "Hyundai Creta"
}
]
},
{
"id": 3609,
"client_number": "00001",
"owner_id": 226,
"created_at": "2020-04-22T12:32:29.000Z",
"full_name": "Glenn M Jackson",
"phones": [
"404-550-6227"
],
"emails": [
"john@example.com"
],
"address": "4447 Mount Olive Road",
"organization_id": null,
"additional": "generated at fakeaddressgenerator",
"list_tags": [
"fake",
"fun"
],
"custom_properties": [
{
"id": 1021,
"name": "Car",
"data_type": "string",
"value": "Hyundai Solaris"
}
]
}
]
}
eq | not_eq | contains | not_contains | empty | not_empty | gt | lt | |
---|---|---|---|---|---|---|---|---|
client_number | - | - | - | - | - | - | + | + |
created_at | + | + | - | - | - | - | + | + |
full_name | - | - | + | + | - | - | - | - |
phone | - | - | - | - | + | + | - | - |
- | - | + | + | + | + | - | - | |
organization_id | + | + | - | - | + | + | - | - |
address | - | - | + | + | + | + | - | - |
additional | - | - | + | + | + | + | - | - |
list_tag | + | + | + | + | + | + | - | - |
owner_id | + | + | - | - | - | - | - | - |
Дополнительное поле типа string | + | + | + | + | + | + | - | - |
Дополнительное поле типа number | + | + | - | - | + | + | + | + |
Дополнительное поле типа date | + | + | - | - | + | + | + | + |