Read a catalog manifest

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

Returns the manifest of a catalog block: which nodes, card sets and style settings the block has. Use the selectors from the manifest to edit the block's nodes and cards on a page.

Parameters

Parameter	Type	Required	Description
Parameter`code` (path)	Typestring	Requiredyes	DescriptionCatalog block code, for example `bitrix:03.1.three_cols_big_with_text_and_titles` or `03.1.three_cols_big_with_text_and_titles` — both forms are accepted. Get the codes from `GET /v1/block-repository`: the code is the key of an item in a section's `items`. Encode colons and `@` in the code with `encodeURIComponent`
Parameter`scope` (query)	Typestring	Requiredno	DescriptionInternal landing area: `KNOWLEDGE` — knowledge base, `GROUP` — group knowledge base, `MAINPAGE` — home page. Omit it for a regular site

Examples

curl — personal key

Terminal

curl "https://vibecode.bitrix24.com/v1/block-repository/bitrix%3A03.1.three_cols_big_with_text_and_titles/manifest" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal

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

JavaScript — personal key

javascript

const code = encodeURIComponent("bitrix:03.1.three_cols_big_with_text_and_titles")
const response = await fetch(`https://vibecode.bitrix24.com/v1/block-repository/${code}/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 code = encodeURIComponent("bitrix:03.1.three_cols_big_with_text_and_titles")
const response = await fetch(`https://vibecode.bitrix24.com/v1/block-repository/${code}/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
Field`success`	Typeboolean	DescriptionAlways `true` on success
Field`data.code`	Typestring	DescriptionBlock code in the form it was passed in the path
Field`data.block`	Typeobject	DescriptionBlock description: title `name`, description `description`, catalog sections `section`, site types `type`. Returned if present in the manifest
Field`data.nodes`	Typeobject \| array	DescriptionBlock nodes. The key is a node selector, the value is the title `name` and the type `type`, for example `text` or `img`. Returned if present in the manifest
Field`data.cards`	Typeobject \| array	DescriptionCard sets. The key is a set selector, the value is the title `name`, the label nodes `label` and the presets `presets`, if any. A block without cards returns an empty array `[]`. Returned if present in the manifest
Field`data.style`	Typeobject \| array	DescriptionStyle settings. The key is an element selector or a group, the value is the title and the available setting types. Returned if present in the manifest
Field`data.assets`	Typeobject \| array	DescriptionFiles the block includes. Returned if present in the manifest

Response example

Only some of the style keys are shown. The full response has six:

JSON

{
  "success": true,
  "data": {
    "code": "bitrix:03.1.three_cols_big_with_text_and_titles",
    "block": {
      "name": "Full-width 3-column text on a colored background",
      "description": "Three columns with titles and text",
      "section": [
        "columns",
        "text"
      ]
    },
    "nodes": {
      ".landing-block-node-subtitle": {
        "name": "Subtitle",
        "type": "text"
      },
      ".landing-block-node-title": {
        "name": "Title",
        "type": "text"
      },
      ".landing-block-node-text": {
        "name": "Text",
        "type": "text"
      }
    },
    "cards": {
      ".landing-block-card": {
        "name": "Column",
        "label": [
          ".landing-block-node-subtitle",
          ".landing-block-node-title"
        ]
      }
    },
    "style": {
      ".landing-block-inner-container": {
        "name": "Columns",
        "type": [
          "row-align"
        ]
      },
      ".landing-block-card": {
        "name": "Column",
        "type": [
          "columns",
          "animation"
        ]
      }
    }
  }
}

Error response example

404 — the catalog has no block with this code, or the block has no manifest file: