List pages

GET /v1/pages

Returns a list of landing and online-store pages with support for filtering and auto-pagination. By default only non-deleted pages are returned.

The domainId (DOMAIN_ID) field is not requested by default. An explicit selection of this field is forwarded to Bitrix24 and can return 422 BITRIX_ERROR with the Bitrix24 code SYSTEM_ERROR.

Parameters

Examples

curl — personal key

curl -g "https://vibecode.bitrix24.com/v1/pages?filter[siteId]=3&limit=10&select=id,title,code,siteId,active,dateCreate,dateModify" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl -g "https://vibecode.bitrix24.com/v1/pages?filter[siteId]=3&limit=10&select=id,title,code,siteId,active,dateCreate,dateModify" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const params = new URLSearchParams({
  'filter[siteId]': '3',
  limit: '10',
  select: 'id,title,code,siteId,active,dateCreate,dateModify',
})

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

const { success, data, meta } = await res.json()
console.log(`Found ${meta.total} pages`)

JavaScript — OAuth application

const params = new URLSearchParams({
  'filter[siteId]': '3',
  limit: '10',
  select: 'id,title,code,siteId,active,dateCreate,dateModify',
})

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

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

Response fields

Date format. dateCreate and dateModify are strings in the account locale format, not ISO 8601 (30.12.2021 12:30:52 in the RU locale, 12/30/2021 12:30:52 pm in the EN locale). The format is the same in the list and in the get-by-ID response; do not rely on new Date() to parse such a value. Details: Field reference.

The URL of any page from the data array is built from its id and siteId:

https://<portal>.bitrix24.com/sites/site/<siteId>/view/<id>/

<siteId> — ID of the site the page belongs to (the siteId field of each item). <portal> — the Bitrix24 portal domain. Access is restricted by the employee's permissions in Bitrix24.

Response example

{
  "success": true,
  "data": [
    {
      "id": 9,
      "title": "Page migration test",
      "code": "change1",
      "siteId": 3,
      "active": true,
      "description": null,
      "createdById": 1,
      "dateCreate": "26.05.2020 17:24:02",
      "dateModify": "10.10.2022 15:25:30"
    },
    {
      "id": 7,
      "title": "Test page",
      "code": "test",
      "siteId": 3,
      "active": true,
      "description": null,
      "createdById": 1,
      "dateCreate": "25.05.2020 17:34:17",
      "dateModify": "10.10.2022 15:25:30"
    }
  ],
  "meta": {
    "total": 13,
    "hasMore": true
  }
}

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.

Known specifics

Pagination via offset is supported. Vibecode returns the requested [offset, offset + limit) window. The meta.total value is the exact number of records matching the filter, and meta.hasMore shows whether there are records beyond the window.

Default order is by site. Without sort or order, pages are returned in ascending siteId order, and within a site in ascending id order. To order pages by id across all sites, use sort=id.

Knowledge base and other internal areas. The scope parameter switches the source: KNOWLEDGE — knowledge base pages, GROUP — workgroup pages, MAINPAGE — main pages. Without the parameter, pages of regular landing sites are returned (the default source). Example: GET /v1/pages?scope=KNOWLEDGE returns knowledge base pages.

See also

• Get a page
• Search pages
• Create a page
• Update a page
• Delete a page
• Sites
• Filtering syntax
• Entity API
• Batch
• Limits and optimization