Skip to main content

Get all pages

In this example, we demonstrate how to retrieve all pages from the CMS project (not just root-level ones) using the OneEntry API.

✅ Purpose of the scenario:

  • Connect to the OneEntry API
  • Retrieve all pages across all depth levels in a single call
  • Filter pages by type using the type field

✅ What you need:

  • A valid PROJECT_URL and APP_TOKEN for authentication with the OneEntry API.
  • At least one page configured in OneEntry.

📌 Important:

  • These examples do not include error handling.
  • You can manage errors using a try-catch block or by employing a construction like await Promise.catch((error) => error).
  • Returns a plain array, NOT { items, total }. Includes pages of all depths — use depth field or parentId to build a tree.
  • The type field is "common_page" for content pages and "catalog_page" for pages with products.
  • The products field on each page object shows the count of products assigned to that page.

📚 See in documentation:

📦 SDK reference:

Try it live​

Run this method interactively in the JS SDK sandbox — connect your Project URL and App Token on first visit, then open:

  • Get all pages — In this example, we demonstrate how to retrieve all pages from the CMS project (not just root-level ones) using the OneEntry API.

Scenario​

1. Import defineOneEntry from SDK and define PROJECT_URL and APP_TOKEN​

Example:

import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Creating an API client with defineOneEntry()​

Example:

const { Pages } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Get all pages with Pages.getPages()​

Example:

// Returns a plain array (NOT `{ items, total }`)
const pages = await Pages.getPages('en_US');

if ('statusCode' in pages) {
  throw new Error(pages.message);
}
Result:
[
  {
    "id": 49,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "products",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Products",
      "menuTitle": "Products",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 3,
    "childrenCount": "0",
    "type": "catalog_page",
    "position": 9,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "products",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": []
  },
  {
    "id": 35,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "get-all-pages",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Get all pages",
      "mdContent": "",
      "menuTitle": "Get all pages",
      "htmlContent": "<p>In this example, we demonstrate how to retrieve all pages of all depths using the OneEntry API.</p>",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": "0",
    "type": "common_page",
    "position": 8,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "get-all-pages",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": []
  },
  {
    "id": 10,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "blocks",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Blocks",
      "menuTitle": "Blocks",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": "0",
    "type": "common_page",
    "position": 7,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "blocks",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": []
  },
  {
    "id": 9,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "home_web",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Home web",
      "menuTitle": "Home web",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": "0",
    "type": "common_page",
    "position": 6,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "home_web",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": []
  },
  {
    "id": 7,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "premium_page",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Premium page",
      "menuTitle": "Premium page",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": "0",
    "type": "common_page",
    "position": 5,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "premium_page",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": []
  },
  {
    "id": 6,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "subscriptions",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Subscriptions",
      "menuTitle": "Subscriptions",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 3,
    "childrenCount": "0",
    "type": "catalog_page",
    "position": 4,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "subscriptions",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": []
  },
  {
    "id": 8,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "tickets",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Tickets",
      "menuTitle": "Tickets",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 3,
    "childrenCount": "0",
    "type": "catalog_page",
    "position": 3,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "tickets",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": [
      {
        "id": 5,
        "formIdentifier": "spam_form",
        "moduleIdentifier": "content",
        "isGlobal": false,
        "isClosed": false,
        "isModerate": true,
        "viewOnlyMyData": false,
        "commentOnlyMyData": false,
        "entityIdentifiers": [
          {
            "id": "tickets",
            "isNested": false
          }
        ],
        "formDataCount": 0,
        "ratingCalculation": "average",
        "allowHalfRatings": null,
        "maxRatingScale": null,
        "isAnonymous": null,
        "allowRerating": null,
        "isRating": null,
        "entityFormDataCount": {},
        "nestedEntityIdentifiers": [],
        "exceptionIds": []
      }
    ]
  },
  {
    "id": 11,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "schedule",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Schedule form",
      "mdContent": "",
      "menuTitle": "Schedule form",
      "htmlContent": "<p>In this example, we demonstrate how to get a form with a timeInterval field and submit a selected time slot using the OneEntry API.</p>",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": "0",
    "type": "common_page",
    "position": 2,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "schedule",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": [
      {
        "id": 7,
        "formIdentifier": "schedule",
        "moduleIdentifier": "content",
        "isGlobal": false,
        "isClosed": false,
        "isModerate": true,
        "viewOnlyMyData": false,
        "commentOnlyMyData": false,
        "entityIdentifiers": [
          {
            "id": "schedule",
            "isNested": false
          }
        ],
        "formDataCount": 1,
        "ratingCalculation": "average",
        "allowHalfRatings": null,
        "maxRatingScale": null,
        "isAnonymous": null,
        "allowRerating": null,
        "isRating": null,
        "entityFormDataCount": {
          "schedule": 1
        },
        "nestedEntityIdentifiers": [],
        "exceptionIds": []
      }
    ]
  },
  {
    "id": 2,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "services",
    "attributeSetIdentifier": null,
    "total": "9",
    "localizeInfos": {
      "title": "Services",
      "menuTitle": "Services",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 3,
    "childrenCount": "0",
    "type": "catalog_page",
    "position": 1,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "services",
    "rating": {},
    "attributeValues": {},
    "moduleFormConfigs": [
      {
        "id": 3,
        "formIdentifier": "file",
        "moduleIdentifier": "content",
        "isGlobal": false,
        "isClosed": false,
        "isModerate": false,
        "viewOnlyMyData": false,
        "commentOnlyMyData": false,
        "entityIdentifiers": [
          {
            "id": "services",
            "isNested": false
          }
        ],
        "formDataCount": 14,
        "ratingCalculation": "average",
        "allowHalfRatings": null,
        "maxRatingScale": null,
        "isAnonymous": null,
        "allowRerating": null,
        "isRating": null,
        "entityFormDataCount": {
          "services": 14
        },
        "nestedEntityIdentifiers": [],
        "exceptionIds": []
      },
      {
        "id": 2,
        "formIdentifier": "contact_us",
        "moduleIdentifier": "content",
        "isGlobal": false,
        "isClosed": false,
        "isModerate": false,
        "viewOnlyMyData": false,
        "commentOnlyMyData": false,
        "entityIdentifiers": [
          {
            "id": "services",
            "isNested": false
          }
        ],
        "formDataCount": 60,
        "ratingCalculation": "average",
        "allowHalfRatings": null,
        "maxRatingScale": null,
        "isAnonymous": null,
        "allowRerating": null,
        "isRating": null,
        "entityFormDataCount": {
          "services": 60
        },
        "nestedEntityIdentifiers": [],
        "exceptionIds": []
      },
      {
        "id": 1,
        "formIdentifier": "entity",
        "moduleIdentifier": "content",
        "isGlobal": false,
        "isClosed": false,
        "isModerate": false,
        "viewOnlyMyData": false,
        "commentOnlyMyData": false,
        "entityIdentifiers": [
          {
            "id": "services",
            "isNested": false
          }
        ],
        "formDataCount": 31,
        "ratingCalculation": "average",
        "allowHalfRatings": null,
        "maxRatingScale": null,
        "isAnonymous": null,
        "allowRerating": null,
        "isRating": null,
        "entityFormDataCount": {
          "services": 31
        },
        "nestedEntityIdentifiers": [],
        "exceptionIds": []
      }
    ]
  }
]

4. Filter and access page fields​

Example:

const catalogPages = pages.filter((p: { type: string }) => p.type === 'catalog_page');
console.log('catalogPages ', catalogPages);
const commonPages = pages.filter((p: { type: string }) => p.type === 'common_page');
console.log('commonPages ', commonPages);

pages.forEach((page) => {
  const title = page.localizeInfos?.title;
  const type = page.type; // "common_page" | "catalog_page"
  const pageUrl = page.pageUrl;
  const depth = page.depth; // 0 for root, 1+ for children
  const parentId = page.parentId; // null for root pages
  console.log(title, type, pageUrl, depth, parentId);
});
Result:
{
  "title": "Services",
  "type": "catalog_page",
  "pageUrl": "services",
  "depth": 0,
  "parentId": null
}

Final example​

// 1. Import defineOneEntry from SDK and define PROJECT_URL and APP_TOKEN
import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

// 2. Creating an API client with [defineOneEntry()](/docs/index/#Installation)
const { Pages } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Get all pages with [Pages.getPages()](/docs/pages/getPages)
// Returns a plain array (NOT `{ items, total }`)
const pages = await Pages.getPages('en_US');

if ('statusCode' in pages) {
  throw new Error(pages.message);
}

// 4. Filter and access page fields
const catalogPages = pages.filter((p: { type: string }) => p.type === 'catalog_page');
console.log('catalogPages ', catalogPages);
const commonPages = pages.filter((p: { type: string }) => p.type === 'common_page');
console.log('commonPages ', commonPages);

pages.forEach((page) => {
  const title = page.localizeInfos?.title;
  const type = page.type; // "common_page" | "catalog_page"
  const pageUrl = page.pageUrl;
  const depth = page.depth; // 0 for root, 1+ for children
  const parentId = page.parentId; // null for root pages
  console.log(title, type, pageUrl, depth, parentId);
});