Wishlists API

v1.0 • REST • JSON

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

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/wishlists

Quick Reference

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

Get All Wishlists

Retrieves a paginated list of all wishlists 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/wishlists/{id} 200 OK

Get Single Wishlist

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

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

Wishlist Not Found

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

Response: 404 Not Found
POST /api/wishlists 201 Created

Create Wishlist

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

Request Body
Field Type Required Description
userId integer Optional User id
name string Required Name
description string Required Description
isPublic boolean Required Is public
Body
Response: 201 Created
PUT /api/wishlists/{id} 200 OK

Update Wishlist

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

Request Body
Field Type Required Description
userId integer Optional User id
name string Required Name
description string Required Description
isPublic boolean Required Is public
Body
Response: 200 OK
DELETE /api/wishlists/{id} 204 No Content

Delete Wishlist

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

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the wishlist to delete
Response: 204 No Content