#Список документов

GET /v1/documents

Возвращает список документов с поддержкой фильтрации, сортировки, выбора полей и автоматической пагинации.

#Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей (до 5000). При limit > 50 Вайбкод автоматически запрашивает несколько страниц
offset number 0 Пропустить N записей. При offset > 0 рекомендуется limit ≤ 500
select string — Выборка полей: ?select=id,title,number
order object — Сортировка: ?order[id]=desc
filter object — Фильтрация по полям GET /v1/documents/fields.
Синтаксис фильтрации. Пример: ?filter[templateId]=53

#Примеры

#curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/documents?limit=10&order[id]=desc&filter[templateId]=53" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/documents?limit=10&order[id]=desc&filter[templateId]=53" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents?limit=10&order[id]=desc&filter[templateId]=53', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} документов`)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents?limit=10&order[id]=desc&filter[templateId]=53', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив документов (все поля элемента — см. Поля документа)
meta.total number Количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

#Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "id": 51,
      "title": "Договор поставки 2026-001",
      "number": "2026-001",
      "templateId": 53,
      "provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
      "value": "ORDER-1024",
      "fileId": 241,
      "pdfId": 245,
      "imageId": 243,
      "createTime": "2026-03-18T17:27:48+03:00",
      "updateTime": "2026-03-18T17:27:48+03:00",
      "createdBy": 503,
      "updatedBy": null,
      "values": { "DocumentNumber": "2026-001" },
      "stampsEnabled": false,
      "downloadUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&id=51",
      "pdfUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getpdf&id=51"
    },
    {
      "id": 52,
      "title": "Договор поставки 2026-002",
      "number": "2026-002",
      "templateId": 53,
      "provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
      "value": "ORDER-1025",
      "fileId": 248,
      "pdfId": 250,
      "imageId": 249,
      "createTime": "2026-03-19T10:12:03+03:00",
      "updateTime": "2026-03-19T10:12:03+03:00",
      "createdBy": 503,
      "updatedBy": null,
      "values": { "DocumentNumber": "2026-002" },
      "stampsEnabled": false,
      "downloadUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&id=52",
      "pdfUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getpdf&id=52"
    }
  ],
  "meta": { "total": 2, "hasMore": false }
}

#Пример ответа при ошибке

400 — фильтр по несуществующему полю:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'zzzNope' for entity 'documents'. Available: id, title, number, templateId, providerClassName, value, values, fields, createTime, updateTime, fileId, pdfId, imageId, stampsEnabled, provider, downloadUrl, pdfUrl, imageUrl, downloadUrlMachine, pdfUrlMachine, imageUrlMachine, createdBy, updatedBy, publicUrl"
  }
}

#Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет у документа. Список полей — GET /v1/documents/fields
403 SCOPE_DENIED Ключу не хватает скоупа documentgenerator
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

#Известные особенности

При limit > 50 Вайбкод запрашивает несколько страниц и собирает все записи в один ответ. За один вызов возвращается не более 5000 записей.

При offset ≥ 2500 для устойчивости запроса используйте limit ≤ 500.

Для сложных фильтров с множеством условий параметры передаются в теле запроса — POST /v1/documents/search. Этот эндпоинт также поддерживает оконный поиск по датам для больших выборок. См. Поиск документов.

#Смотрите также