Menus API

v1.0 • REST • JSON

Full CRUD management for menu item accounts. Create, retrieve, update, and delete menu item records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints Auth Required
Base URL https://bogusapi.com/api/menus

Quick Reference

GET
/api/menus List all menus (paginated)
200 GET
/api/menus/{id} Get one menu item by ID
200 POST
/api/menus Create a new menu item
201 PUT
/api/menus/{id} Replace menu item data
204 DEL
/api/menus/{id} Remove a menu item
204 GET
/api/menus/{id} Menu Item not found example
404
GET /api/menus 200 OK

Get All Menus

Retrieves a paginated list of all menus in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/menus/{id} 200 OK

Get Single Menu Item

Fetch the full profile for a specific menu item using their numeric ID. Returns all menu item fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique menu item identifier
Response: 200 OK
GET /api/menus/{id} 404 Not Found

Menu Item Not Found

Returned when the requested menu item ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing menu item resources.

Response: 404 Not Found 
{}
POST /api/menus 201 Created

Create Menu Item

Registers a new menu item with the provided details. On success, returns the newly created menu item object — including the auto-generated ID, timestamp, and resolved role names.

Request Body
FieldTypeRequiredDescription
firstName string Required Menu Item's given name
lastName string Required Menu Item's family name
email string Required Unique email address
password string Required Plaintext password for the account
roleIds integer[] Optional IDs of roles to assign on creation
Body
Response: 201 Created
PUT /api/menus/{id} 200 OK

Update Menu Item

Fully replaces an existing menu item's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
FieldTypeRequiredDescription
firstName string Required Updated first name
lastName string Required Updated last name
email string Required Updated email address
roleIds integer[] Optional New role assignment (replaces existing)
Body
Response: 200 OK
DELETE /api/menus/{id} 204 No Content

Delete Menu Item

Permanently removes a menu item from the system by their ID. This action is irreversible — once deleted, the menu item record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the menu item to delete
Response: 204 No Content 
{}