Menus

List menu items

get/menu

Request

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

Query parameters

space_idinteger

If provided, returns the menu items of the given space (requires administration permission). If omitted, returns the menu items available to the current user.

loadAll'true' | 'false'

When set to 'true' and the current user is an admin, returns all menu items across spaces instead of only the user's items.

filterstring

Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.

offsetinteger

Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.

limitinteger

Maximum number of records to return. Use together with offset for pagination.

orderstring

Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

Response

List of menu items

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.