For AI agents: markdown of this page — /docs-content-en/entities/storages/list.md documentation index — /llms.txt

List storages

GET /v1/storages

Returns a list of Bitrix24.Disk storages with exact field-value filtering and auto-pagination.

Parameters

Parameter Type Default Description
limit number 50 Number of records (up to 5000). When limit > 50, the request is automatically assembled from several pages on the server side
offset number 0 Skip N records. Used to read result sets larger than 5000 records
select string — Field selection: ?select=id,name. Only the listed fields are returned
filter object — Exact equality and $in (IN-set) only, over the fields id, name, code, entityType, entityId. Operators (>, >=, <, <=, !, %, $ne, $contains, $nin) and other fields (for example rootFolderId) are not supported — you get 400 UNSUPPORTED_FILTER.
Filtering syntax. Example: ?filter[entityType]=group

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/storages?limit=10&filter[entityType]=group', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Total storages under the filter: ${meta.total}`)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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()

Response fields

Field Type Description
success boolean Always true on success
data array Array of storages
data[].id number Storage identifier
data[].name string Storage name
data[].code string | null Symbolic code. null on the accounts checked
data[].module string Owner module of the storage, disk for Disk
data[].entityType string Owner type: user, group, common
data[].entityId string Owner identifier. A string, non-numeric for the shared drive
data[].rootFolderId number Identifier of the storage root folder
meta.total number Total number of records matching the filter
meta.hasMore boolean Whether additional records are present

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Letta",
      "code": null,
      "module": "disk",
      "entityType": "user",
      "entityId": "1",
      "rootFolderId": 1
    },
    {
      "id": 11,
      "name": "Shared drive",
      "code": null,
      "module": "disk",
      "entityType": "common",
      "entityId": "shared_files_s1",
      "rootFolderId": 19
    }
  ],
  "meta": {
    "total": 490,
    "hasMore": true
  }
}

Error response example

400 — operator or unsupported field in the filter:

JSON 
{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_FILTER",
    "message": "UNSUPPORTED_FILTER: 'rootObjectId' is not filterable on 'storages'. Its Bitrix24 method (disk.storage.getlist) filters by exact match only. Filterable: id, name, code, entityType, entityId."
  }
}

Errors

HTTP Code Description
400 UNSUPPORTED_FILTER Operator or unsupported field in the filter. Filter by exact equality or $in over id, name, code, entityType, entityId
400 INVALID_SORT_FIELD order or sort was passed — storages do not support sorting
403 SCOPE_DENIED The API key does not have the disk scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

Result sets larger than 5000 records. A single response returns up to 5000 storages. The total number of records under the filter comes in meta.total, and the flag indicating a continuation is in meta.hasMore. If more than 5000 records match the filter, read the continuation with the offset parameter, increasing it by the size of the chunk you received.

See also