Список хранилищ

GET /v1/storages

Возвращает список хранилищ Битрикс24.Диска с фильтрацией по точному совпадению полей и автопагинацией.

Параметры

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

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/storages?limit=10&filter[entityType]=group" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/storages?limit=10&filter[entityType]=group" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/storages?limit=10&filter[entityType]=group', {
  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/storages?limit=10&filter[entityType]=group', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив хранилищ
data[].id number Идентификатор хранилища
data[].name string Название хранилища
data[].code string | null Символьный код. На проверенных порталах null
data[].module string Модуль-владелец хранилища, для Диска — disk
data[].entityType string Тип владельца: user, group, common
data[].entityId string Идентификатор владельца. Строка, у общего диска нечисловая
data[].rootFolderId number Идентификатор корневой папки хранилища
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Признак наличия дополнительных записей

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Летта",
      "code": null,
      "module": "disk",
      "entityType": "user",
      "entityId": "1",
      "rootFolderId": 1
    },
    {
      "id": 11,
      "name": "Общий диск",
      "code": null,
      "module": "disk",
      "entityType": "common",
      "entityId": "shared_files_s1",
      "rootFolderId": 19
    }
  ],
  "meta": {
    "total": 490,
    "hasMore": true
  }
}

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'disk' scope"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_SORT_FIELD Передан order или sort — хранилища не поддерживают сортировку
403 SCOPE_DENIED API-ключ не имеет скоупа disk
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Выборки больше 5000 записей. За один ответ возвращается до 5000 хранилищ. Общее число записей под фильтром приходит в meta.total, признак наличия продолжения — в meta.hasMore. Если под фильтр попадает больше 5000 записей, читайте продолжение параметром offset, увеличивая его на размер полученной порции.

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