RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Change Log

  • 05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Admin Menu API

Retrieve and Update the Admin Menu via the public API endpoint.

GET Admin Menu

Retrieves the full Admin Menu configuration, including both the default menu items and any custom menu items defined for the site.

/api/v2/admin/admin-menu

Data / Response:

N/A

{
  "Default": [
    {
      "EntityAlias": "string",
      "IsDisabled": true,
      "EntityType": "string",
      "DefaultName": "string",
      "DefaultItemsView": "string",
      "Name": "string",
      "Href": "string",
      "Type": "string",
      "Icon": "string",
      "Enable": true,
      "Weight": 0,
      "Children": [
        "string"
      ]
    }
  ],
  "Custom": [
    {
      "EntityAlias": "string",
      "IsDisabled": true,
      "EntityType": "string",
      "DefaultName": "string",
      "DefaultItemsView": "string",
      "Name": "string",
      "Href": "string",
      "Type": "string",
      "Icon": "string",
      "Enable": true,
      "Weight": 0,
      "Children": [
        "string"
      ]
    }
  ]
}

PUT Admin Menu

Updates the Admin Menu configuration. Submit the full updated menu item array to replace the existing configuration.

/api/v2/admin/admin-menu

Data / Response:

[
  {
    "EntityAlias": "string",
    "IsDisabled": true,
    "EntityType": "string",
    "DefaultName": "string",
    "DefaultItemsView": "string",
    "Name": "string",
    "Href": "string",
    "Type": "string",
    "Icon": "string",
    "Enable": true,
    "Weight": 0,
    "Children": [
      "string"
    ]
  }
]

{
  "Id": 0,
  "IsInvited": true,
  "FirstName": "string",
  "LastName": "string",
  "Email": "user@example.com",
  "EnableOse": true,
  "UserId": 0,
  "RoleId": 0
}