Для AI-агентов: markdown этой страницы — /docs-content/sign-b2e/list-personal-documents.md индекс документации — /llms.txt
Личные подписанные документы
GET /v1/sign-b2e/personal-documents
Возвращает подписанные документы текущего пользователя. Нужна авторизация OAuth. Ссылки с учётными данными заменяются безопасной отметкой.
Скоупы: sign.b2e.
Доступен только ключу OAuth-приложения с пользовательской сессией. Для входящего вебхука возвращается 422 BITRIX_ERROR с нативным кодом WRONG_AUTH_TYPE в error.b24Code.
Параметры запроса (query)
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрlimit |
Типinteger | string | Обяз.нет | ОписаниеПо умолчанию 20; от 1 до 1000. Неверное значение ядро заменяет на 20. |
Параметрoffset |
Типinteger | string | Обяз.нет | ОписаниеСмещение от начала списка; по умолчанию 0. |
Примеры
curl — OAuth-приложение
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/personal-documents' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN'
JavaScript — OAuth-приложение
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/personal-documents', {
"method": "GET",
"headers": {
"X-Api-Key": "YOUR_APP_KEY",
"Authorization": "Bearer USER_SESSION_TOKEN"
}
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеУспешность запроса. |
Полеdata |
Типarray | ОписаниеДанные операции. |
Полеdata[].id |
Типinteger | ОписаниеИдентификатор объекта. |
Полеdata[].title |
Типstring | ОписаниеНазвание объекта. |
Полеdata[].signed_date |
Типstring | null | ОписаниеДата подписи в ATOM. |
Полеdata[].file_url |
Типstring | ОписаниеURL файла; при наличии учётных данных заменён на [REDACTED]. |
Полеmeta.redacted |
Типarray | ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений. |
Пример ответа
Форма успешного ответа; данные зависят от портала и запроса.
{
"success": true,
"data": []
}
Пример ответа при ошибке
403 — ключу не выдан обязательный скоуп:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'sign.b2e' scope"
}
}
Ошибки
| HTTP | Код | Причина |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ПричинаНеверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса. |
| HTTP401 | КодTOKEN_MISSING |
ПричинаНет учётных данных соединения с Битрикс24. |
| HTTP403 | КодSCOPE_DENIED |
ПричинаНе выдан один из обязательных скоупов. |
| HTTP422 | КодBITRIX_ERROR |
ПричинаБитрикс24 отказал в операции; код в error.b24Code, текст в error.message. |
| HTTP422 | КодBITRIX_ERROR |
ПричинаВходящий вебхук вместо OAuth. Нативный код WRONG_AUTH_TYPE передаётся в error.b24Code. |
Известные особенности
Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.
Размер страницы по умолчанию 20, максимум 1000. Недопустимый limit заменяется на 20, недопустимый offset — на 0. Эти правила применяет Битрикс24.