> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/integrate/openapi/menuboard.md). # MenuBoard Menu Boards - feature preview, please do not use in production. ## Search Menu Boards > Search all Menu Boards this user has access to ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"MenuBoard":{"properties":{"menuId":{"description":"The Menu Board Id","type":"integer"},"name":{"description":"The Menu Board name","type":"string"},"description":{"description":"The Menu Board description","type":"string"},"code":{"description":"The Menu Board code identifier","type":"string"},"userId":{"description":"The Menu Board owner Id","type":"integer"},"modifiedDt":{"description":"The Menu Board last modified date","type":"integer"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to","type":"string"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board","type":"string"}}}}},"paths":{"/menuboards":{"get":{"tags":["menuBoard"],"summary":"Search Menu Boards","description":"Search all Menu Boards this user has access to","operationId":"menuBoardSearch","parameters":[{"schema":{"type":"integer"},"name":"menuId","in":"query","description":"Filter by Menu board Id","required":false},{"schema":{"type":"integer"},"name":"userId","in":"query","description":"Filter by Owner Id","required":false},{"schema":{"type":"integer"},"name":"folderId","in":"query","description":"Filter by Folder Id","required":false},{"schema":{"type":"string"},"name":"name","in":"query","description":"Filter by name","required":false},{"schema":{"type":"string"},"name":"code","in":"query","description":"Filter by code","required":false}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}}}} ``` ## Add Menu Board > Add a new Menu Board ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"MenuBoard":{"properties":{"menuId":{"description":"The Menu Board Id","type":"integer"},"name":{"description":"The Menu Board name","type":"string"},"description":{"description":"The Menu Board description","type":"string"},"code":{"description":"The Menu Board code identifier","type":"string"},"userId":{"description":"The Menu Board owner Id","type":"integer"},"modifiedDt":{"description":"The Menu Board last modified date","type":"integer"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to","type":"string"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board","type":"string"}}}}},"paths":{"/menuboard":{"post":{"tags":["menuBoard"],"summary":"Add Menu Board","description":"Add a new Menu Board","operationId":"menuBoardAdd","responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Menu Board name"},"description":{"type":"string","description":"Menu Board description"},"code":{"type":"string","description":"Menu Board code identifier"},"folderId":{"type":"integer","description":"Menu Board Folder Id"}},"required":["name"]}}}}}}}} ``` ## Edit Menu Board > Edit existing Menu Board ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/menuboard/{menuId}":{"put":{"tags":["menuBoard"],"summary":"Edit Menu Board","description":"Edit existing Menu Board","operationId":"menuBoardEdit","parameters":[{"schema":{"type":"integer"},"name":"menuId","in":"path","description":"The Menu Board ID to Edit","required":true}],"responses":{"204":{"description":"successful operation"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Menu Board name"},"description":{"type":"string","description":"Menu Board description"},"code":{"type":"string","description":"Menu Board code identifier"},"folderId":{"type":"integer","description":"Menu Board Folder Id"}},"required":["name"]}}}}}}}} ``` ## Delete Menu Board > Delete existing Menu Board ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/menuboard/{menuId}":{"delete":{"tags":["menuBoard"],"summary":"Delete Menu Board","description":"Delete existing Menu Board","operationId":"menuBoardDelete","parameters":[{"schema":{"type":"integer"},"name":"menuId","in":"path","description":"The Menu Board ID to Delete","required":true}],"responses":{"204":{"description":"successful operation"}}}}}} ``` ## Menu Board Select folder > Select Folder for Menu Board ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"MenuBoard":{"properties":{"menuId":{"description":"The Menu Board Id","type":"integer"},"name":{"description":"The Menu Board name","type":"string"},"description":{"description":"The Menu Board description","type":"string"},"code":{"description":"The Menu Board code identifier","type":"string"},"userId":{"description":"The Menu Board owner Id","type":"integer"},"modifiedDt":{"description":"The Menu Board last modified date","type":"integer"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to","type":"string"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board","type":"string"}}}}},"paths":{"/menuboard/{id}/selectfolder":{"put":{"tags":["menuBoard"],"summary":"Menu Board Select folder","description":"Select Folder for Menu Board","operationId":"menuBoardSelectFolder","parameters":[{"schema":{"type":"integer"},"name":"menuId","in":"path","description":"The Menu Board ID","required":true}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"folderId":{"type":"integer","description":"Folder ID to which this object should be assigned to"}},"required":["folderId"]}}}}}}}} ``` ## Search Menu Board Categories > Search all Menu Boards Categories this user has access to ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"MenuBoard":{"properties":{"menuId":{"description":"The Menu Board Id","type":"integer"},"name":{"description":"The Menu Board name","type":"string"},"description":{"description":"The Menu Board description","type":"string"},"code":{"description":"The Menu Board code identifier","type":"string"},"userId":{"description":"The Menu Board owner Id","type":"integer"},"modifiedDt":{"description":"The Menu Board last modified date","type":"integer"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to","type":"string"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board","type":"string"}}}}},"paths":{"/menuboard/{menuId}/categories":{"get":{"tags":["menuBoard"],"summary":"Search Menu Board Categories","description":"Search all Menu Boards Categories this user has access to","operationId":"menuBoardCategorySearch","parameters":[{"schema":{"type":"integer"},"name":"menuId","in":"path","description":"Filter by Menu board Id","required":true},{"schema":{"type":"integer"},"name":"menuCategoryId","in":"query","description":"Filter by Menu Board Category Id","required":false},{"schema":{"type":"string"},"name":"name","in":"query","description":"Filter by name","required":false},{"schema":{"type":"string"},"name":"code","in":"query","description":"Filter by code","required":false}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}}}} ``` ## Add Menu Board > Add a new Menu Board Category ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"MenuBoard":{"properties":{"menuId":{"description":"The Menu Board Id","type":"integer"},"name":{"description":"The Menu Board name","type":"string"},"description":{"description":"The Menu Board description","type":"string"},"code":{"description":"The Menu Board code identifier","type":"string"},"userId":{"description":"The Menu Board owner Id","type":"integer"},"modifiedDt":{"description":"The Menu Board last modified date","type":"integer"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to","type":"string"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board","type":"string"}}}}},"paths":{"/menuboard/{menuId}/category":{"post":{"tags":["menuBoard"],"summary":"Add Menu Board","description":"Add a new Menu Board Category","operationId":"menuBoardCategoryAdd","parameters":[{"schema":{"type":"integer"},"name":"menuId","in":"path","description":"The Menu Board ID to which we want to add this Category to","required":true}],"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Menu Board Category name"},"mediaId":{"type":"integer","description":"Media ID associated with this Menu Board Category"},"code":{"type":"string","description":"Menu Board Category code identifier"},"description":{"type":"string","description":"Menu Board Category description"}},"required":["name"]}}}}}}}} ``` ## Edit Menu Board Category > Edit existing Menu Board Category ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/menuboard/{menuCategoryId}/category":{"put":{"tags":["menuBoard"],"summary":"Edit Menu Board Category","description":"Edit existing Menu Board Category","operationId":"menuBoardCategoryEdit","parameters":[{"schema":{"type":"integer"},"name":"menuCategoryId","in":"path","description":"The Menu Board Category ID to Edit","required":true}],"responses":{"204":{"description":"successful operation"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Menu Board name"},"mediaId":{"type":"integer","description":"Media ID from CMS Library to associate with this Menu Board Category"},"code":{"type":"string","description":"Menu Board Category code identifier"},"description":{"type":"string","description":"Menu Board Category description"}},"required":["name"]}}}}}}}} ``` ## Delete Menu Board Category > Delete existing Menu Board Category ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/menuboard/{menuCategoryId}/category":{"delete":{"tags":["menuBoard"],"summary":"Delete Menu Board Category","description":"Delete existing Menu Board Category","operationId":"menuBoardCategoryDelete","parameters":[{"schema":{"type":"integer"},"name":"menuId","in":"path","description":"The menuId to Delete","required":true}],"responses":{"204":{"description":"successful operation"}}}}}} ``` ## Search Menu Board Products > Search all Menu Boards Products this user has access to ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"MenuBoard":{"properties":{"menuId":{"description":"The Menu Board Id","type":"integer"},"name":{"description":"The Menu Board name","type":"string"},"description":{"description":"The Menu Board description","type":"string"},"code":{"description":"The Menu Board code identifier","type":"string"},"userId":{"description":"The Menu Board owner Id","type":"integer"},"modifiedDt":{"description":"The Menu Board last modified date","type":"integer"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to","type":"string"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board","type":"string"}}}}},"paths":{"/menuboard/{menuCategoryId}/products":{"get":{"tags":["menuBoard"],"summary":"Search Menu Board Products","description":"Search all Menu Boards Products this user has access to","operationId":"menuBoardProductsSearch","parameters":[{"schema":{"type":"integer"},"name":"menuCategoryId","in":"path","description":"Filter by Menu Board Category Id","required":true},{"schema":{"type":"integer"},"name":"menuId","in":"query","description":"Filter by Menu board Id","required":false},{"schema":{"type":"string"},"name":"name","in":"query","description":"Filter by name","required":false},{"schema":{"type":"string"},"name":"code","in":"query","description":"Filter by code","required":false}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}}}} ``` ## Add Menu Board Product > Add a new Menu Board Product ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"MenuBoard":{"properties":{"menuId":{"description":"The Menu Board Id","type":"integer"},"name":{"description":"The Menu Board name","type":"string"},"description":{"description":"The Menu Board description","type":"string"},"code":{"description":"The Menu Board code identifier","type":"string"},"userId":{"description":"The Menu Board owner Id","type":"integer"},"modifiedDt":{"description":"The Menu Board last modified date","type":"integer"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to","type":"string"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board","type":"string"}}}}},"paths":{"/menuboard/{menuCategoryId}/product":{"post":{"tags":["menuBoard"],"summary":"Add Menu Board Product","description":"Add a new Menu Board Product","operationId":"menuBoardProductAdd","responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Menu Board Product name"},"description":{"type":"string","description":"Menu Board Product description"},"price":{"type":"number","description":"Menu Board Product price"},"allergyInfo":{"type":"string","description":"Menu Board Product allergyInfo"},"calories":{"type":"integer","description":"Menu Board Product calories"},"displayOrder":{"type":"integer","description":"Menu Board Product Display Order, used for sorting"},"availability":{"type":"integer","description":"Menu Board Product availability"},"mediaId":{"type":"integer","description":"Media ID from CMS Library to associate with this Menu Board Product"},"code":{"type":"string","description":"Menu Board Product code"},"productOptions":{"type":"array","description":"An array of optional Product Option names"},"productValues":{"type":"array","description":"An array of optional Product Option values"}},"required":["name","displayOrder"]}}}}}}}} ``` ## Edit Menu Board Product > Edit existing Menu Board Product ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/menuboard/{menuProductId}/product":{"put":{"tags":["menuBoard"],"summary":"Edit Menu Board Product","description":"Edit existing Menu Board Product","operationId":"menuBoardProductEdit","parameters":[{"schema":{"type":"integer"},"name":"menuProductId","in":"path","description":"The Menu Board Product ID to Edit","required":true}],"responses":{"204":{"description":"successful operation"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Menu Board Product name"},"description":{"type":"string","description":"Menu Board Product description"},"price":{"type":"number","description":"Menu Board Product price"},"allergyInfo":{"type":"string","description":"Menu Board Product allergyInfo"},"calories":{"type":"integer","description":"Menu Board Product calories"},"displayOrder":{"type":"integer","description":"Menu Board Product Display Order, used for sorting"},"availability":{"type":"integer","description":"Menu Board Product availability"},"mediaId":{"type":"integer","description":"Media ID from CMS Library to associate with this Menu Board Product"},"code":{"type":"string","description":"Menu Board Product code"},"productOptions":{"type":"array","description":"An array of optional Product Option names"},"productValues":{"type":"array","description":"An array of optional Product Option values"}},"required":["name","displayOrder"]}}}}}}}} ``` ## Delete Menu Board > Delete existing Menu Board Product ```json {"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/menuboard/{menuProductId}/product":{"delete":{"tags":["menuBoard"],"summary":"Delete Menu Board","description":"Delete existing Menu Board Product","operationId":"menuBoardProductDelete","parameters":[{"schema":{"type":"integer"},"name":"menuProductId","in":"path","description":"The Menu Board Product ID to Delete","required":true}],"responses":{"204":{"description":"successful operation"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.xibosignage.com/developer/integrate/openapi/menuboard.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.