Open API v2 / CMS & Content / Admin Menu

Admin Menu

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/admin-menu#

Retrieves a admin menus

Response

Defaultarray of objects

Built-in admin menu items that ship with the platform, defining the standard navigation of the site's admin panel.

Customarray of objects

Admin menu items added by the agency on top of the defaults, letting them extend the admin navigation with their own sections and links.

curl "https://your-site.webinone.com/api/v2/admin/admin-menu" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/admin-menu", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/admin-menu",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/admin-menu', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/admin-menu");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Default": [
    {
      "EntityAlias": "string",
      "IsDisabled": false,
      "EntityType": "string",
      "DefaultName": "Example",
      "DefaultItemsView": "string",
      "Name": "Example",
      "Href": "https://example.com",
      "Type": "string",
      "Icon": "string",
      "Enable": false,
      "Weight": 10,
      "Children": []
    }
  ],
  "Custom": [
    {
      "EntityAlias": "string",
      "IsDisabled": false,
      "EntityType": "string",
      "DefaultName": "Example",
      "DefaultItemsView": "string",
      "Name": "Example",
      "Href": "https://example.com",
      "Type": "string",
      "Icon": "string",
      "Enable": false,
      "Weight": 10,
      "Children": []
    }
  ]
}

PUT/api/v2/admin/admin-menu#

Updates an existing admin menu

Body parameters

EntityAliasstring · nullable

Technical alias of the entity to which the item leads.

IsDisabledboolean

If true, the menu item will be disabled.

EntityTypestring · nullable

Object type. Helps the system determine processing logic.

DefaultNamestring · nullable

Standard menu item name.

DefaultItemsViewstring · nullable

Specifies the display mode for related data.

Namestring · nullable

Display name of the menu item.

Hrefstring · nullable

The URL or path where the administrator will go after clicking on the item.

Typestring · nullable

Menu item type.

Iconstring · nullable

Use the add file icon () in this field to choose from a range of system icons or alternatively upload your own custom image.

Enableboolean

Items are enabled by default. Uncheck this option to hide this menu item from the admin, but not delete it permanently.

Weightinteger

The ordinal number (weight) for sorting. The lower the number, the higher the item in the list.

Childrenarray of objects

An array of child elements. Used to create drop-down lists or multi-level menu structures.

Response

Idinteger

The unique identifier of the administrator entry in the access rights table. Read-only.

IsInvitedboolean

A boolean flag indicating whether the user has been sent an email invitation. If true, the user has yet to confirm registration or set a password.

FirstNamestring · nullable

User name.

LastNamestring · nullable

User's last name.

Emailstring · nullable

An email address that is also the login for entering the admin panel.

EnableOseboolean

This flag enables specific access rights to the advanced operator interface.

UserIdinteger

Global user identifier in a common authentication system.

RoleIdinteger · nullable

The numeric identifier of the assigned role, which defines the set of available permissions.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/admin-menu" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '[{"EntityAlias":"string","IsDisabled":false,"EntityType":"string","DefaultName":"Example","DefaultItemsView":"string","Name":"Example","Href":"https://example.com","Type":"string","Icon":"string","Enable":false,"Weight":10,"Children":[{"EntityAlias":"string","IsDisabled":false,"EntityType":"string","DefaultName":"Example","DefaultItemsView":"string","Name":"Example","Href":"https://example.com","Type":"string","Icon":"string","Enable":false,"Weight":10,"Children":[]}]}]'

await fetch("https://your-site.webinone.com/api/v2/admin/admin-menu", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify([
    {
      "EntityAlias": "string",
      "IsDisabled": false,
      "EntityType": "string",
      "DefaultName": "Example",
      "DefaultItemsView": "string",
      "Name": "Example",
      "Href": "https://example.com",
      "Type": "string",
      "Icon": "string",
      "Enable": false,
      "Weight": 10,
      "Children": [
        {
          "EntityAlias": "string",
          "IsDisabled": false,
          "EntityType": "string",
          "DefaultName": "Example",
          "DefaultItemsView": "string",
          "Name": "Example",
          "Href": "https://example.com",
          "Type": "string",
          "Icon": "string",
          "Enable": false,
          "Weight": 10,
          "Children": []
        }
      ]
    }
  ])
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/admin-menu",
    headers={"Authorization": "Bearer <token>"},
    json=[{
        "EntityAlias": "string",
        "IsDisabled": False,
        "EntityType": "string",
        "DefaultName": "Example",
        "DefaultItemsView": "string",
        "Name": "Example",
        "Href": "https://example.com",
        "Type": "string",
        "Icon": "string",
        "Enable": False,
        "Weight": 10,
        "Children": [{
            "EntityAlias": "string",
            "IsDisabled": False,
            "EntityType": "string",
            "DefaultName": "Example",
            "DefaultItemsView": "string",
            "Name": "Example",
            "Href": "https://example.com",
            "Type": "string",
            "Icon": "string",
            "Enable": False,
            "Weight": 10,
            "Children": []
        }]
    }]
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/admin-menu', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [[
        'EntityAlias' => 'string',
        'IsDisabled' => false,
        'EntityType' => 'string',
        'DefaultName' => 'Example',
        'DefaultItemsView' => 'string',
        'Name' => 'Example',
        'Href' => 'https://example.com',
        'Type' => 'string',
        'Icon' => 'string',
        'Enable' => false,
        'Weight' => 10,
        'Children' => [[
            'EntityAlias' => 'string',
            'IsDisabled' => false,
            'EntityType' => 'string',
            'DefaultName' => 'Example',
            'DefaultItemsView' => 'string',
            'Name' => 'Example',
            'Href' => 'https://example.com',
            'Type' => 'string',
            'Icon' => 'string',
            'Enable' => false,
            'Weight' => 10,
            'Children' => []
        ]]
    ]]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/admin-menu");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "[{\"EntityAlias\":\"string\",\"IsDisabled\":false,\"EntityType\":\"string\",\"DefaultName\":\"Example\",\"DefaultItemsView\":\"string\",\"Name\":\"Example\",\"Href\":\"https://example.com\",\"Type\":\"string\",\"Icon\":\"string\",\"Enable\":false,\"Weight\":10,\"Children\":[{\"EntityAlias\":\"string\",\"IsDisabled\":false,\"EntityType\":\"string\",\"DefaultName\":\"Example\",\"DefaultItemsView\":\"string\",\"Name\":\"Example\",\"Href\":\"https://example.com\",\"Type\":\"string\",\"Icon\":\"string\",\"Enable\":false,\"Weight\":10,\"Children\":[]}]}]",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "IsInvited": false,
  "FirstName": "Example",
  "LastName": "Example",
  "Email": "user@example.com",
  "EnableOse": false,
  "UserId": 1,
  "RoleId": 1
}