Skip to main content
GET /documents возвращает документы, видимые владельцу ключа в реестре, от новых к старым. Область — documents:read. Элементы списка несут только скалярные поля документа: files и route в них не входят, за ними обращайтесь к GET /documents/{document_id}.

Фильтры

Фильтр status принимает ровно одно значение: чтобы собрать документы в двух статусах, сделайте два запроса. Пагинация — общая, через limit и page_token; поля total_count здесь нет.

Чего в списке нет

Документ, доступный вам только через участие в маршруте — вы подписант или согласующий, но не инициатор и прав на документ у вас нет, — в списке не появится. Реестр перечисляет документы по инициатору и по правам, участие в маршруте туда не входит. GET /documents/{id} по такому документу работает.
Значит, интегратору-участнику нужен другой вход: подпишитесь на события document.approval_started и document.signing_started и запоминайте document_id из них. Пошагово это разобрано в рецепте Согласовать документ как участник.

Что использовать вместо опроса

Списковый опрос не заменяет события: между двумя опросами документ успевает пройти несколько статусов. Держите список для сверки и отчётов, а реакцию стройте на событиях документов.

Сверка после простоя

Если вебхуки не доходили, заберите всё изменившееся с момента последней успешной доставки:
Порядок DOCUMENT_ORDER_UPDATED_AT_ASC важен: документ, изменившийся во время обхода, уезжает вперёд от вашего чекпойнта, а не проскакивает мимо. Двигайте чекпойнт по update_time последней обработанной записи.
Смещение часового пояса в query кодируйте как %2B05:00 или присылайте время в Z (UTC): «плюс» в URL иначе трактуется как пробел.