Перейти к основному содержанию
GET
curl
Эндпоинт Get a Sync Run возвращает одну синхронизацию с результатом по каждому счёту и ресурсу: количество добавленных, изменённых и удалённых записей либо ошибку. Значение sync_id берётся из Обновить подключение или из webhook bank.data.updated.

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения берётся в разделе Developers -> API keys в Business Console. Основной ключ имеет полный доступ. Именованный ключ можно ограничить: доступ для каждого ресурса (нет доступа, только чтение или запись), ограничение некоторыми сценариями или одобренными сессиями, список IP-адресов и дата истечения срока. Ответ 401 означает, что ключ неверный, отозван или истёк. Ответ 403 означает, что ключ не передан, у ключа нет доступа к этому ресурсу или действию либо запрос пришёл с адреса вне его списка IP. Ответ 404 на маршруте сессии означает, что сессия находится вне сценариев или статусов, доступных ключу. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без права записи в сессии получает ссылки и токены сессий как null. См. https://docs.didit.me/console/api-keys.

Параметры пути

id
string<uuid>
обязательно

Идентификатор подключения.

sync_id
string<uuid>
обязательно

Идентификатор запуска синхронизации.

Ответ

Запуск синхронизации.

Одна синхронизация подключения. Перечислены только первоначальные, плановые и запрошенные синхронизации.

id
string<uuid>
обязательно
connection_id
string<uuid>
обязательно
trigger
enum<string>
обязательно
Доступные опции:
initial,
scheduled,
requested
status
enum<string>
обязательно
Доступные опции:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
обязательно
finished_at
string<date-time> | null
обязательно
results
object[]
обязательно

Что выполнил запуск, по каждому счёту и ресурсу.

error
object | null
обязательно

Почему запуск завершился ошибкой в целом. null, если запуск не завершился ошибкой. Ошибки отдельных счетов и ресурсов находятся в results.

Последнее изменение 22 ноября 2026 г.