Loading ...

REST API: Get Page Builder Widget | Axero Documentation

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

REST API: Get Page Builder Widget

0 
 /5
0 (0votes)
Open API Guide
GET/api/pb/widgets/{WidgetID}

Retrieves one Page Builder widget by its ID, with the full definition as stored. Read a widget here before you change it, because REST API: Update Page Builder Widget takes the whole object back.

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
WidgetID Integer YES Path ID of the widget, from the Widgets of REST API: Get Page Builder Page. A value that is not a whole number answers 400.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/pb/widgets/6597

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "AuthorID": 630,
    "DateCreated": "2026-09-27T03:02:55.637",
    "DateUpdated": "2026-09-27T03:05:15.1844419Z",
    "IsSavedWidget": false,
    "IsLocked": false,
    "PageID": 1265,
    "ParentID": 6596,
    "HideContainerBorder": false,
    "ShowWidgetFooter": false,
    "ShowWidgetHeader": false,
    "SortOrder": 1,
    "LoadOrder": 3,
    "TemplateID": 0,
    "UpdatedByUserID": 0,
    "WidgetDependency": "Communifire.Core.RawHtmlWidget, Communifire.Core",
    "WidgetID": 6597,
    "WidgetIDString": "6597",
    "WidgetProperties": "{\"TemplateID\":null,\"RawHtml\":\"<p>Welcome to the team page.</p>\"}",
    "WidgetTitle": "Raw HTML",
    "WidgetTitleResourceKey": "Raw HTML",
    "WidgetTypeID": 18,
    "WidgetTypeName": "Raw HTML",
    "WidgetTypeIconCSS": "icon-code",
    "IsMobile": false,
    "SavedWidgetID": 0,
    "IsCached": false,
    "SavedWidgetUseCount": 0,
    "EditGlobally": false,
    "IsUpdated": false,
    "TenantID": 1
  }
}

Error Response

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

Error Handling

Status Code Likely Cause Next Action
400 Bad Request WidgetID in the path is not an integer. Send the widget's numeric ID.
401 Unauthorized Missing or invalid Bearer token. Check token validity. Learn how to create Bearer tokens →
403 Forbidden The caller cannot administer Page Builder at the site level (for a saved widget) or in the page's space (No permission). Call with a token that can manage Page Builder there.
404 Not Found No widget has that ID (Widget not found), the widget has no page (Widget's PageID not found), or its page no longer exists (Widget's page not found). The body carries the message with IsError true. Verify the WidgetID.
200 with a list WidgetID was left out of the path, so the request matched the route that lists every widget on the site. The response is a bare list of widgets. Put the WidgetID in the path.
500 Server Error 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