Loading ...

REST API: Get Page Builder Page | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Get Page Builder Page
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 11

REST API: Get Page Builder Page

0 
 /5
0 (0votes)
Open API Guide
GET/api/pb/pages/{PageID}

Retrieves a Page Builder page by its ID, with its widgets and how they nest. Use it to find the WidgetID of a widget you want to read or update. The response is the page object itself, not the standard response with IsError, ResponseMessage, and ResponseData.

Use a bearer token for this endpoint. /api/pb/pages, /api/pb/pages/{PageID}, and /api/pb/pages/html accept the token in the Authorization header, and also when it is sent as the Rest-Api-Key header. An anonymous call answers 401. To find a PageID, list pages with GET /api/pb/pages (REST API: List Page Builder Pages), or read it off the page's edit address, which ends in the ID. A caller without permission to view Page Builder pages gets 403 with an empty body.

Request

Request Header

Header Required Value Description
Authorization YES Bearer YOUR_TOKEN Bearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

Parameter Type Required Location Description
PageID Integer YES Path ID of the Page Builder page, from REST API: List Page Builder Pages or the end of the page's edit address (PageEditURL in the response). 0 returns an empty page object, or a new page for FormID. A value that is not a whole number answers 400.

Optional Parameters

Parameter Type Required Location Description
SpaceID Integer NO Query The space whose Page Builder permission is checked, for a caller who manages Page Builder pages in one space only. Site administrators skip the check. Defaults to 0, the site-level permission. A value that is not a whole number is treated as 0.
FormID Integer NO Query When PageID is 0, build a new page for this form instead of loading a page. Ignored when PageID is above 0. A FormID with no form behind it answers 500. Defaults to 0.
PageHistoryID Integer NO Query Load this saved version of the page from its history instead of the current one. When it is set, the PageID in the path is not used, and the version comes back whichever page it belongs to. An ID with no saved version answers 404; a value that is not a whole number is ignored, so the current version comes back. Defaults to 0, the current version.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/pb/pages/1265

Success Response

{
  "PageID": 1265,
  "PageName": "Team Home",
  "SpaceID": 313,
  "SpaceName": "Marketing",
  "ShowSpaceMenu": false,
  "PageURL": "/spaces/313/marketing/team-home",
  "PageURLPartial": "/team-home",
  "PageAbsoluteURL": "https://your-site.com/spaces/313/marketing/team-home",
  "PageEditURL": "/admin/uibuilder/pages/addedit/1265",
  "Type": 1,
  "Widgets": [
    {
      "WidgetID": 6595,
      "WidgetTypeID": 13,
      "WidgetTitle": "Layout",
      "ParentID": 0,
      "ChildWidgets": [
        {
          "WidgetID": 6596,
          "WidgetTypeID": 12,
          "WidgetTitle": "Layout",
          "ParentID": 6595,
          "ChildWidgets": [
            {
              "WidgetID": 6597,
              "WidgetTypeID": 18,
              "WidgetTitle": "Raw HTML",
              "ParentID": 6596,
              "WidgetProperties": "{\"TemplateID\":null,\"RawHtml\":\"<p>Welcome to the team page.</p>\"}",
              ...
            }
          ],
          ...
        }
      ],
      ...
    }
  ],
  ...
}

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status Code Likely Cause Next Action
400 Bad Request PageID in the path is not an integer. Send the page's numeric ID.
401 Unauthorized Missing or invalid Bearer token. Check token validity. Learn how to create Bearer tokens →
403 Forbidden The caller cannot view Page Builder pages, at site level or in the space named by SpaceID. The body is empty. Call with a token for a user who can view Page Builder pages.
200 with a listPageID was left out of the path, so the request matched the listing route instead and every page came back.Put the PageID in the path. To list pages on purpose, use REST API: List Page Builder Pages.
404 Not Found No page has that ID (or no saved version has PageHistoryID); the response has no body. Verify the PageID.
500 Server Error PageID was 0 and FormID named a form that does not exist, or an internal failure. Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages