---
title: "Письма клиента, которые можно привязать к карточке"
method: GET
path: "/api/v1/crm/{entity}/{id}/mail/candidates"
tags: ["CRM links"]
---

# Письма клиента, которые можно привязать к карточке

`GET /api/v1/crm/{entity}/{id}/mail/candidates`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/crm/{entity}/{id}/mail/candidates`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://erp.akeda.ru/oauth2/authorize`, token URL `https://erp.akeda.ru/oauth2/token`, scopes: `akeda:delegate`)

До 30 недавних писем с адресов почты клиента записи и на них, свежие сверху: только письма, которые человек видит в почте, и только те, чья переписка ещё не привязана к записи. Без адресов почты у клиента — пустой список. Привязать письмо — crmLinkCardMail. Нужны право изменять запись и право mail на чтение — без него 403 crm.mail_forbidden; модуль «Почта» не подключён — 409 crm.module_unavailable.

## Response `200`

Письма для привязки

- CRMMailMessageList: Письма, свежие сверху
  - `items` CRMMailMessage[], required
    - `id` string, uuid, required
    - `thread_id` string, uuid, required
    - `account_id` string, uuid, required
    - `subject` string, required
    - `from_address` string, required
    - `from_name` string, required
    - `to` string[], required: Адреса получателей и копии
    - `snippet` string, required: Начало текста письма
    - `direction` 'inbound' | 'outbound', required: inbound - пришло в ящик, outbound - ушло из него
    - `at` string, date-time, required: Когда письмо отправлено или получено
    - `is_read` boolean, required

## Other responses

- `400`: Некорректный запрос или нарушение бизнес-правила
- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права
- `404`: Запись не найдена или не видима текущему пользователю
- `409`: Конфликт версии, идемпотентности или бизнес-состояния
- `503`: Внешний банк, справочник или контур подключений временно недоступен

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/a99574d597cc?raw)