Untuk agen AI: markdown halaman ini — /docs-content-en/entities/pages/catalog-manifest.md indeks dokumentasi — /llms.txt

Artikel dokumentasi saat ini tersedia dalam bahasa Inggris.

Read a catalog manifest

GET /v1/block-repository/:code/manifest

Returns code and the available block, nodes, cards, style and assets fields. Keys of nodes are node selectors; keys of cards are card selectors. A missing or empty manifest returns 404. Application blocks repo_N have no manifest file and return 404. URL-encode codes containing dots, colon or @.

Requires the landing scope. READONLY keys can read. Optional query scope=KNOWLEDGE|GROUP|MAINPAGE selects the page context. No body is accepted by the contract. Credential-bearing strings are replaced with [REDACTED], including the entire HTML string if needed. The Bitrix24 response is bounded to 8 MiB; exceeding the limit returns 502.

Request parameters

Field Type Required Description
code string yes Non-empty URL-encoded block code, for example bitrix:01.big_with_text_3 or repo_12.
scope string no KNOWLEDGE, GROUP or MAINPAGE; omit for an ordinary site.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/block-repository/bitrix%3A01.big_with_text_3/manifest" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/block-repository/bitrix%3A01.big_with_text_3/manifest" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch("https://vibecode.bitrix24.com/v1/block-repository/bitrix%3A01.big_with_text_3/manifest", {
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

JavaScript — OAuth application

javascript 
const response = await fetch("https://vibecode.bitrix24.com/v1/block-repository/bitrix%3A01.big_with_text_3/manifest", {
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

Response fields

Field Type Description
success boolean true
data object Operation result.
data.code string Requested code.
data.block object Optional block descriptor.
data.nodes object or array Optional node selector dictionary.
data.cards object or array Optional card selector dictionary.
data.style object or array Optional style descriptor.
data.assets object or array Optional resources.

Response

JSON 
{
  "success": true,
  "data": {
    "code": "bitrix:01.big_with_text_3",
    "block": {
      "name": "Example"
    },
    "nodes": {
      ".title": {
        "name": "Title"
      }
    },
    "cards": {},
    "style": {}
  }
}

Errors

HTTP Code Condition
400 INVALID_PARAMS Invalid pageId/blockId or blank code.
400 INVALID_SCOPE Invalid scope.
401 TOKEN_MISSING No Bitrix24 credentials.
403 SCOPE_DENIED Key lacks landing scope.
403 BITRIX_ACCESS_DENIED Bitrix24 user lacks permission.
404 ENTITY_NOT_FOUND Block not in this page, missing sample or manifest file.
409 LANDING_MODULE_NOT_ENABLED The Sites module is unavailable on this Bitrix24 account.
422 BITRIX_ERROR Bitrix24 business refusal; message preserved.
502 BITRIX_INVALID_RESPONSE Unexpected result or Bitrix24 response exceeds 8 MiB.

All system errors.

See also