Menus
> Auto-generated from the OpenAPI spec. Method names shown are the manifest > (canonical) names; per-language casing is applied by each SDK.
Record handle: ref(id) → a lazy handle to one Menu (get/update/delete, field values, related records). See record handles.
create
POST /menu
Create a menu item
| Parameter | In | Required | Description |
|---|---|---|---|
body |
body | yes |
Returns: Menu · Cost: 1 API call.
delete
DELETE /menu/{menuId}
Delete a menu item
| Parameter | In | Required | Description |
|---|---|---|---|
menuId |
path | yes | Menu item ID |
Returns: any · Cost: 1 API call.
get
GET /menu/{menuId}
Get a menu item by ID
| Parameter | In | Required | Description |
|---|---|---|---|
menuId |
path | yes | Menu item ID |
Returns: Menu · Cost: 1 API call.
list
GET /menu
List menu items
| Parameter | In | Required | Description |
|---|---|---|---|
space_id |
query | no | 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 |
query | no | When set to 'true' and the current user is an admin, returns all menu items across spaces instead of only the user's items. |
filter |
query | no | 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. |
offset |
query | no | Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30. |
limit |
query | no | Maximum number of records to return. Use together with offset for pagination. |
order |
query | no | 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. |
Returns: list<Menu> · Cost: 1 API call per page (lazy paginator).
update
PUT /menu/{menuId}
Update a menu item
| Parameter | In | Required | Description |
|---|---|---|---|
menuId |
path | yes | Menu item ID |
body |
body | yes |
Returns: Menu · Cost: 1 API call.
