Menus

Get a menu item by ID

get/menu/{menuId}

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/menu/{menuId}
  • Auth: HTTP bearer

Path parameters

menuIdinteger required

Menu item ID

Response

Menu object

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of the user who created this record

updatedstring date-time

Last update timestamp

updatedUserIdinteger

ID of the user who last updated this record

modifiedstring date-time

Timestamp of the last modification of the menu item

entityIdinteger

ID of the entity the menu item points to

parentIdinteger nullable

ID of the parent menu item; null for top-level items

customModuleIdinteger

ID of the custom module the menu item is bound to

spaceIdinteger required

ID of the space this menu item belongs to

type'module' | 'link' | 'folder' | 'custom-module'

Type of the menu item

modulestring

System name of the module the item links to (for type 'module')

viewstring

View/action within the target module

contentstring

Link URL or custom content (for type 'link')

targetstring

Link target (e.g. _blank, _self)

orderinteger

Sort order of the menu item within its level

namestring required

Display name of the menu item

colorstring

Display color for the menu item in hex format (e.g. #FF5733)

iconstring

Icon identifier for the menu item

displayboolean

True if the menu item should be displayed, false otherwise

usersinteger[]

IDs of users allowed to see this menu item

teamsinteger[]

IDs of teams allowed to see this menu item

categoriesinteger[]

IDs of categories allowed to see this menu item

Example response

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "modified": "2026-01-15T09:30:00Z",
  "entityId": 42,
  "parentId": 42,
  "customModuleId": 42,
  "spaceId": 42,
  "type": "module",
  "module": "string",
  "view": "string",
  "content": "string",
  "target": "string",
  "order": 1,
  "name": "Sample name",
  "color": "#1f6feb",
  "icon": "string",
  "display": true,
  "users": [
    1
  ],
  "teams": [
    1
  ],
  "categories": [
    1
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.