# Список

{% hint style="info" %}
**Нужно помнить:** позиции в списке будут выданы согласно уровня доступа собственника токена. 

О правах <https://help.myfreshcloud.com/settings/users/access-rights>
{% endhint %}

## Список контрагентов с постраничной выдачей

<mark style="color:green;">`POST`</mark> <https://do.freshoffice.ru/common/list/paging/1?columns=id,name>

{% hint style="danger" %}
myfreshcloud.com - домен API для  подписок которые еще не успели мигрировать \
\
[https://do.myfreshcloud.com/common/list/paging/1?columns=id,name](https://do.freshoffice.ru/common/list/paging/1?columns=id,name)

{% endhint %}

#### Path Parameters

| Name                                 | Type | Description |
| ------------------------------------ | ---- | ----------- |
| /1<mark style="color:red;">\*</mark> | Int  | Код модуля  |

#### Query Parameters

| Name                                      | Type   | Description                          |
| ----------------------------------------- | ------ | ------------------------------------ |
| sorting\_direction                        | Int    | Сортировка 0 Asc 1 Desc              |
| sorting\_column                           | String | Колонка сортировки                   |
| page                                      | int    | Номер страницы                       |
| records\_onpage                           | Int    | Записей на странице, но не более 500 |
| columns<mark style="color:red;">\*</mark> | String | Список колонок                       |

#### Headers

| Name                                            | Type   | Description                |
| ----------------------------------------------- | ------ | -------------------------- |
| Authorization<mark style="color:red;">\*</mark> | String | Bearer XXXXX-XXXXXXX-XXXXX |
| Content-Type                                    | String | application/json           |

{% tabs %}
{% tab title="200: OK Стандартный объект ответа" %}

```
{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 1,
  "pages": 1,
  "page": 1,
  "value": "[
       {"id":1,"name":"Apple"}
  ]"
```

{% endtab %}

{% tab title="401: Unauthorized " %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## Пример

{% tabs %}
{% tab title="cURL" %}

```
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 ''
```

{% endtab %}

{% tab title="PHP" %}

```
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://do.myfreshcloud.com/common/list/paging/1
  ?columns=id,name
  &records_onpage=1000
  &sorting_direction=0
  &sorting_column=id&user_ids=37',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer XXXXX.XXXXX.XXXXX'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

{% endtab %}

{% tab title="NodeJs(Request)" %}

```
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://do.myfreshcloud.com/common/list/paging/1
  ?columns=id,name
  &records_onpage=1000
  &sorting_direction=0
  &sorting_column=id
  &user_ids=37',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer XXXXXX.XXXXXX.XXXXXX'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
})
```

{% endtab %}
{% endtabs %}

## Columns

<table><thead><tr><th width="378">Имя</th><th>Описание</th></tr></thead><tbody><tr><td><strong>id</strong></td><td>Идентификатор контрагента</td></tr><tr><td><strong>name</strong></td><td>Наименование. Наименование контрагента</td></tr><tr><td><strong>address</strong></td><td>Адрес. Адрес контрагента</td></tr><tr><td><strong>create</strong>d</td><td>Дата и время внесения. Дата и время добавления контрагента</td></tr><tr><td><strong>city</strong></td><td>Город. Город контрагента</td></tr><tr><td><strong>region</strong></td><td>Регион. Регион контрагента</td></tr><tr><td><strong>country</strong></td><td>Страна. Страна контрагента</td></tr><tr><td><strong>activity_type</strong></td><td>Деятельность. Вид деятельности контрагента</td></tr><tr><td><strong>property_form</strong></td><td>Форма собственности. Форма собственности контрагента</td></tr><tr><td><strong>type_id</strong></td><td>Идентификатор типа контрагента</td></tr><tr><td><strong>type</strong></td><td></td></tr><tr><td><strong>created_by</strong></td><td>Имя пользователя или способ добавления контрагента</td></tr><tr><td><strong>info_source</strong></td><td>Источник. Регион контрагента</td></tr><tr><td><strong>first_name</strong></td><td>Имя (физического лица)</td></tr><tr><td><strong>middle_name</strong></td><td>Отчество (физического лица)</td></tr><tr><td><strong>last_name</strong></td><td>Фамилия (физическое лица)</td></tr><tr><td><strong>url</strong></td><td>Сайт. Вебсайт контрагента</td></tr><tr><td><strong>user_id</strong></td><td>Ответственный. Идентификатор ответственного пользователя</td></tr><tr><td><strong>user_name</strong></td><td>Ответственный. Имя ответственного пользователя</td></tr><tr><td><strong>person</strong></td><td>Признак ЮР/ФИЗ</td></tr><tr><td><strong>note</strong></td><td>Примечание</td></tr><tr><td><strong>external_code</strong></td><td>Код 1С</td></tr><tr><td><strong>category_id</strong></td><td>Идентификатор категории контрагента</td></tr><tr><td><strong>category</strong></td><td>Категория контрагента</td></tr><tr><td><strong>status_id</strong></td><td>Идентификатор статуса контрагента</td></tr><tr><td><strong>status</strong></td><td>Статус контрагента</td></tr><tr><td><strong>agent_id</strong></td><td>Идентификатор агента</td></tr><tr><td><strong>agent</strong></td><td>Аген</td></tr><tr><td><strong>tax_id</strong></td><td>Код налогоплательщика по списку реквизитов компании</td></tr><tr><td><strong>which_site_source</strong></td><td>Web сайт источник лида</td></tr><tr><td><strong>which_host_source</strong></td><td>Web хост источник лида</td></tr><tr><td><strong>which_link_source</strong></td><td>Полная web ссылка источник лида </td></tr><tr><td><strong>utm_campaign</strong></td><td>UTM campaign</td></tr><tr><td><strong>utm_source</strong></td><td>UTM source</td></tr><tr><td><strong>utm_medium</strong></td><td>UTM medium</td></tr><tr><td><strong>utm_content</strong></td><td>UTM content</td></tr><tr><td><strong>utm_term</strong></td><td>UTM term</td></tr><tr><td><strong>ADD_</strong>{name}</td><td> Дополнительные поля</td></tr></tbody></table>

{% content-ref url="/pages/fZsjhP1J1Ge2uwFxY6jU" %}
[Добавленные поля](/reference/dobavlennye-polya.md)
{% endcontent-ref %}

## Фильтрация

{% hint style="info" %}
**На заметку:** можно использовать 2 метода фильтрации. Стандартная фильтрация по колонкам. По ID готового фильтра, который был создан внутри приложения, подробней: <https://help.myfreshcloud.com/settings/filters> ⚡️
{% endhint %}

### Колонки фильтрации

```

?id=1
?name=apple
?email=xxx@gmail.com
?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**   \
> Коды пользователей можно найти в раздели - пользоватли

{% content-ref url="/pages/AZqUPlTdpl1jAyZMvODJ" %}
[Пользователи](/reference/users.md)
{% endcontent-ref %}

### Готовые пользовательские фильтры

```
?user_filter_ids = 1
or
?user_filter_ids=1,2

// user_filter_ids - ID пользовательского фильтра

```

> **⚡️ user\_filter\_ids**
>
> &#x20;  Коды фильтров можно найти в раздели - фильтры

{% content-ref url="/pages/ND7GU7pvI2AJBjjSRpOA" %}
[Фильтры](/reference/filters.md)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidoc.myfreshcloud.com/reference/company/list_of_companies.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.