Page fields

GET /v1/pages/fields

Returns a map of all page fields with their type, label and read-only flag, plus a nullable flag on the fields that can arrive empty. Fields without the read-only flag are writable on create and update.

Examples

curl — personal key

curl "https://vibecode.bitrix24.com/v1/pages/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl "https://vibecode.bitrix24.com/v1/pages/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/pages/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Fields:', Object.keys(data.fields).length)

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/pages/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

The data object contains a fields map (field name → { type, readonly, label }, with a description on some fields and nullable on the fields that can arrive empty), a batch list of bulk-mode operations, and a set of aggregatable fields for grouping in aggregation.

Fields that can be empty

A field Bitrix24 does not always fill carries "nullable": true in the endpoint response, and its type is written as … | null in the table above. There are nine such fields: description, xmlId, tplId, tplCode, folderId, searchContent, initiatorAppCode, rule, datePublic. The value arrives as null — not as an empty string and not as 0 — so check it before parsing. Every other field always has a value.

Date format

Dates are strings in the account locale format, NOT ISO 8601. Bitrix24 returns dateCreate, dateModify and datePublic as strings, and the specific template depends on the regional settings of the account: in the RU locale it is DD.MM.YYYY HH:MM:SS (30.12.2021 12:30:52), in the EN locale it is MM/DD/YYYY hh:mm:ss am/pm (12/30/2021 12:30:52 pm). Vibecode returns the value as is, without normalizing to ISO, in the same format in list and get-by-ID responses — there is no divergence between GET /v1/pages and GET /v1/pages/:id. new Date(value) returns Invalid Date or silently swaps day and month: do not parse the date with a fixed template and do not trust new Date(). The filter needs the same format — see Search pages.

Response example

Besides type and readonly, every field carries a label (short name) and a description, in English. Request headers do not switch the language. A field that can arrive empty additionally carries nullable. In the example below, description is shown on active only — it is omitted from the other fields for brevity.

{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "Page ID" },
      "title": { "type": "string", "readonly": false, "label": "Title" },
      "siteId": { "type": "number", "readonly": false, "label": "Site ID" },
      "active": {
        "type": "boolean",
        "readonly": true,
        "label": "Active",
        "description": "Whether the page is published. Read-only: Bitrix24 does not accept the field on create or on update, and a new page is always created inactive. Publish through POST /v1/pages/:id/publication and unpublish through POST /v1/pages/:id/unpublish."
      },
      "xmlId": { "type": "string", "readonly": false, "nullable": true, "label": "External ID" },
      "datePublic": { "type": "datetime", "readonly": true, "nullable": true, "label": "Published at" }
    },
    "aggregatable": ["siteId", "active", "deleted", "public", "folderId", "tplId", "createdById", "modifiedById"],
    "batch": ["create", "update", "delete"]
  }
}

6 of 27 fields are shown. The full list is in the table above.

Error response example

403 — no scope:

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

Errors

For the full list of common API errors, see Errors.

See also

• Create a page
• Update a page
• Page aggregation
• Pages
• Entity API