Список
Список контрагентов с постраничной выдачей
POST
https://do.myfreshcloud.com/common/list/paging/1
Path Parameters
/1*
Int
Код модуля
Query Parameters
sorting_direction
Int
Сортировка 0 Asc 1 Desc
sorting_column
String
Колонка сортировки
page
int
Номер страницы
records_onpage
Int
Записей на странице, но не более 500
columns*
String
Список колонок
Headers
Authorization*
String
Bearer XXXXX-XXXXXXX-XXXXX
Content-Type
String
application/json
{
"status": "success",
"error": "",
"code": null,
"rows": 1,
"pages": 1,
"page": 1,
"value": "[
{"id":1,"name":"Apple"}
]"
Пример
curl --location --request
POST 'https://do.myfreshcloud.com/common/list/paging/1
?columns=id,name
&records_onpage=1000
&sorting_direction=0
&sorting_column=id
&user_ids=37' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXX.XXXXXXX.XXXXXX' \
--data-raw ''
Columns
id
Идентификатор контрагента
name
Наименование. Наименование контрагента
address
Адрес. Адрес контрагента
created
Дата и время внесения. Дата и время добавления контрагента
city
Город. Город контрагента
region
Регион. Регион контрагента
country
Страна. Страна контрагента
activity_type
Деятельность. Вид деятельности контрагента
property_form
Форма собственности. Форма собственности контрагента
type_id
Идентификатор типа контрагента
type
created_by
Имя пользователя или способ добавления контрагента
info_source
Источник. Регион контрагента
first_name
Имя (физического лица)
middle_name
Отчество (физического лица)
last_name
Фамилия (физическое лица)
url
Сайт. Вебсайт контрагента
user_id
Ответственный. Идентификатор ответственного пользователя
user_name
Ответственный. Имя ответственного пользователя
person
Признак ЮР/ФИЗ
note
Примечание
external_code
Код 1С
category_id
Идентификатор категории контрагента
category
Категория контрагента
status_id
Идентификатор статуса контрагента
status
Статус контрагента
agent_id
Идентификатор агента
agent
Аген
tax_id
Код налогоплательщика по списку реквизитов компании
which_site_source
Web сайт источник лида
which_host_source
Web хост источник лида
which_link_source
Полная web ссылка источник лида
utm_campaign
UTM campaign
utm_source
UTM source
utm_medium
UTM medium
utm_content
UTM content
utm_term
UTM term
ADD_{name}
Дополнительные поля
Фильтрация
Колонки фильтрации
?id=1
?name=apple
[email protected]
?phone=+1 890 745 66 89
?tax_id=7811505326
?user_ids=1 or ?user_ids=1,3,4
?page=1 - Номер страницы которую нужно получить
// id - Код компании
// name - Наименование, поиск по совпадению части символов
// email - Почта контрагента или контактных лиц
// phone - Телефон контрагента или контактных лиц
// tax_id - Код налогоплатильщика по списку реквизитов компании
// user_ids - Код отвественного за контрагента
// page - Номер страницы которую нужно получить
⚡️ tax_id В списке реквизитов компании должна быть выбрана позиция по умолчанию: https://help.myfreshcloud.com/attachment/crm/forms-company
Пользователи⚡️ user_ids Коды пользователей можно найти в раздели - пользоватли
Готовые пользовательские фильтры
?user_filter_ids = 1
or
?user_filter_ids=1,2
// user_filter_ids - ID пользовательского фильтра
Фильтры⚡️ user_filter_ids
Коды фильтров можно найти в раздели - фильтры
Last updated
Was this helpful?