> For the complete documentation index, see [llms.txt](https://apidoc.myfreshcloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.myfreshcloud.com/reference/mail/list_mail.md). # Список {% hint style="info" %} **Нужно помнить:** если нет значений в параметре **user\_ids**, по умолчанию будет показан список писем аккаунтов, которые принадлежат собственнику токена. {% endhint %} ## Список писем с постраничной выдачей `POST` `https://do.myfreshcloud.com/common/list/paging/24` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ---- | ----------- | | /24\* | Int | Код модуля | #### Query Parameters | Name | Type | Description | | ------------------ | ------ | ------------------------------------ | | columns | String | Список колонок | | records\_onpage | Int | Записей на странице, но не более 500 | | page | Int | Номер страницы | | sorting\_column | String | Колонка сортировки | | sorting\_direction | Int | Сортировка {0} Asc / {1} Desc | #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | -------------------------- | | Authorization\* | String | Bearer XXXXX-XXXXXXX-XXXXX | | Content-Type\* | String | application/json | {% tabs %} {% tab title="200: OK Стандартный объект ответа" %} ```javascript { "status": "success", "error": "", "code": null, "rows": 1, "pages": 1, "page": 1, "value": "[ {"id":1,"subject":"Happy!"} ]" ``` {% endtab %} {% tab title="401: Unauthorized " %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Пример {% tabs %} {% tab title="cURL" %} ``` curl --location --request POST 'https://do.myfreshcloud.com/common/list/paging/24 ?records_onpage=50 &sorting_column=id &user_ids=37 &sorting_direction=1 &date1=2021-01-01 &date2=2021-12-31 &page=1 &columns=id,subject,from,from_address,to,to_address,small_part_of_body' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer XXXXXX.XXXXXXX.XXXXXX' \ --data-raw '' ``` {% endtab %} {% tab title="PHP" %} ``` 'https://do.myfreshcloud.com/common/list/paging/24 ?records_onpage=50 &sorting_column=id &user_ids=37 &sorting_direction=1 &date1=2021-01-01 &date2=2021-12-31 &page=1 &columns=id,subject,from,from_address,to,to_address,small_part_of_body', 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.XXXXXX.XXXXXX' ), )); $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/24 ?records_onpage=50 &sorting_column=id &user_ids=37 &sorting_direction=1 &date1=2021-01-01 &date2=2021-12-31 &page=1 &columns=id,subject,from,from_address,to,to_address,small_part_of_body', 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer XXXXXXX.XXXXXXX.XXXXXXX' } }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` {% endtab %} {% endtabs %} ## Columns {% hint style="info" %} **На заметку:** колонки с префиксом **company\_** содержат информацию о контрагенте, это может быть как юридическое лицо, так и физическое. В случае с юридическим лицом **company\_name** это название компании, а в случае с физическим лицом это ФИО физ лица. {% endhint %} | Имя | Описание | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **id** | Код письма | | **from** | От кого, имя или адрес | | **from\_address** | Адрес отправителя | | **to** | Кому, имя или адрес | | **to\_address** | Адрес получателя | | **cc** | Копия получателя | | **bcc** | Скрытая копия получателя | | **subject** | Тема | | **date** | Дата | | **user\_name** | Имя собственника аккаунта | | **company\_name** | Наименование контрагента | | **company\_id** | Идентификатор контрагента | | **contact\_id** | Код контактного лица | | **contact** | Имя контактного лица | | **company\_type\_id** | Код типа контрагента | | **company\_type** | Тип контрагента | | **company\_category\_id** | Код категории контрагента | | **company\_category** | Категория контрагента | | **company\_status\_id** | Код статуса контрагента | | **company\_status** | Статус контрагента | | **dea**l | Наименование сделки | | **deal\_id** | Идентификатор сделки | | **message\_id** | Уникальной ID сообщения сформированный почтённым сервером | | **attachment\_flag** | Признак наличия прикрепления (0/1) | | **small\_part\_of\_body** | Первый 255 символов от контента письма | | **body** |

Содержание письма в формате HTML
⚡️
Не рекомендуется указывать колонку в больших списочных запросах. По возможности получайте позицию одного письма по id. Параметр фильтрации id=xx

| ## Фильтрация {% hint style="info" %} **На заметку:** можно использовать 2 метода фильтрации. Стандартная фильтрация по колонкам. По ID готового фильтра, который был создан внутри приложения, подробней: ⚡️ {% endhint %} ### **Колонки фильтрации** ``` ?id=1 ?segment=1 ?user_ids=1 0r ?user_ids=1,3,5 ?date1=2021-12-01 ?date2=2021-12-31 ?subject=Hapy! ?to_address="support@myfreshcloud.com" ?from_address="support@myfreshcloud.com" ?company_id=1 ?deal_id=1 ?page=1 // id - Код письма // segment - Код папки письма (см.описание) // user_ids - Код пользователя чьи аккаунты нужно просмотреть // date1 - С даты (формат YYYY.MM.DD) // date2 - По дату (формат YYYY.MM.DD) // subject - Тема письма // to_address - Email адрес кому // from_address - Email адрес от кого (все письма по сделке) // company_id - Код контрагента (все письма по компании) // deal_id - Код сделки // page - Номер страницы которую нужно получить ``` > ⚡️**user\_ids** > > Коды пользователей можно найти в раздели - пользоватли {% content-ref url="/pages/AZqUPlTdpl1jAyZMvODJ" %} [Пользователи](/reference/users.md) {% endcontent-ref %} > ⚡️**segment** > > 1. Входящие > 2. Отправленные > 3. Черновики > 4. Корзина > 5. Спам > 6. Еще ### Готовые пользовательские фильтры ``` ?user_filter_ids = 1 or ?user_filter_ids=1,2 ``` > **⚡️ user\_filter\_ids** > > Коды фильтров можно найти в раздели - фильтры {% content-ref url="/pages/ND7GU7pvI2AJBjjSRpOA" %} [Фильтры](/reference/filters.md) {% endcontent-ref %}