Categories API

v1.0 • REST • JSON

Full CRUD management for category accounts. Create, retrieve, update, and delete category 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/categories

Quick Reference

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

Get All Categories

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

Get Single Category

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

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

Category Not Found

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

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

Create Category

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

Request Body
FieldTypeRequiredDescription
firstName string Required Category's given name
lastName string Required Category'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/categories/{id} 200 OK

Update Category

Fully replaces an existing category'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/categories/{id} 204 No Content

Delete Category

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

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