API Reference - Sidebars

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108109

← Back to API Reference | Getting Started

Sidebars

Sidebars are named containers that group widgets together for display in specific positions on your directory pages. Each sidebar has a position type, optional custom CSS and JavaScript, and can be referenced by a short code for use in page layouts.

Model name in URL: sidebars — DB table: sidebars

The Sidebar Object

FieldTypeDescription
sidebar_idintegerUnique sidebar ID (primary key, read-only)
namestringDisplay name for this sidebar (EG Member Profile Page) required on create
desctextOptional description of this sidebar's purpose or usage
activeintegerWhether this sidebar is active and rendered on pages: 1 active, 0 inactive required on create
separatortextHTML markup inserted between widgets in this sidebar
csstextCustom CSS scoped to this sidebar's container element
scripttextCustom JavaScript injected when this sidebar is rendered
date_updatedstringDate this sidebar was last updated (format: YYYYMMDDHHMMSS)
updated_bystringUsername or identifier of the admin who last updated this sidebar
short_codestringShort code token used to embed this sidebar in page templates (EG [sidebar id=3])
typestringLayout position type for this sidebar (EG Left, Right, Full)
div_idstringHTML id attribute applied to the sidebar's wrapper element
div_classstringHTML class attribute applied to the sidebar's wrapper element
revision_timestamptimestampTimestamp of the last modification to this record (auto-managed)

List Sidebars

GET /api/v2/sidebars/get

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/sidebars/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "sidebar_id": "1",
      "name": "Member Profile Page",
      "desc": "",
      "active": "1",
      "separator": "",
      "css": "",
      "script": "",
      "date_updated": "",
      "updated_by": "",
      "short_code": "",
      "type": "Left",
      "div_id": "id",
      "div_class": "",
      "revision_timestamp": "2015-07-04 22:55:03"
    },
    {
      "sidebar_id": "2",
      "name": "Post Search Result",
      "desc": "",
      "active": "1",
      "separator": "",
      "css": "",
      "script": "",
      "date_updated": "",
      "updated_by": "",
      "short_code": "",
      "type": "Right",
      "div_id": "",
      "div_class": "",
      "revision_timestamp": "2015-07-04 22:55:03"
    }
  ],
  "total": "12",
  "current_page": 1,
  "total_pages": 1
}

Retrieve a Sidebar

GET /api/v2/sidebars/get/{sidebar_id}

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/sidebars/get/1" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "sidebar_id": "1",
      "name": "Member Profile Page",
      "desc": "",
      "active": "1",
      "separator": "",
      "css": "",
      "script": "",
      "date_updated": "",
      "updated_by": "",
      "short_code": "",
      "type": "Left",
      "div_id": "id",
      "div_class": "",
      "revision_timestamp": "2015-07-04 22:55:03"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Create a Sidebar

POST /api/v2/sidebars/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/sidebars/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "name=Homepage+Sidebar" \
  -d "active=1" \
  -d "type=Right" \
  -d "div_id=homepage-sidebar" \
  -d "div_class=sidebar-right"

Example Response

Copy
{
  "status": "success",
  "message": {
    "sidebar_id": "15",
    "name": "Homepage Sidebar",
    "desc": null,
    "active": "1",
    "separator": null,
    "css": null,
    "script": null,
    "date_updated": null,
    "updated_by": null,
    "short_code": null,
    "type": "Right",
    "div_id": "homepage-sidebar",
    "div_class": "sidebar-right",
    "revision_timestamp": null
  }
}

Update a Sidebar

PUT /api/v2/sidebars/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/sidebars/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "sidebar_id=15" \
  -d "name=Homepage+Right+Sidebar" \
  -d "css=.sidebar-right+%7B+padding%3A+10px%3B+%7D"

Example Response

Copy
{
  "status": "success",
  "message": {
    "sidebar_id": "15",
    "name": "Homepage Right Sidebar",
    "desc": null,
    "active": "1",
    "separator": null,
    "css": ".sidebar-right { padding: 10px; }",
    "script": null,
    "date_updated": null,
    "updated_by": null,
    "short_code": null,
    "type": "Right",
    "div_id": "homepage-sidebar",
    "div_class": "sidebar-right",
    "revision_timestamp": "2026-04-03 10:00:00"
  }
}

Delete a Sidebar

DELETE /api/v2/sidebars/delete

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/sidebars/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "sidebar_id=15"

Example Response

Copy
{
  "status": "success",
  "message": "sidebars record was deleted"
}