Departments API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Departments

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

Get Single Department

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

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

Department Not Found

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

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

Create Department

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

Request Body
Field Type Required Description
name string Required Name
teamId integer Required Team id
Body
Response: 201 Created
PUT /api/departments/{id} 200 OK

Update Department

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

Request Body
Field Type Required Description
name string Required Name
teamId integer Required Team id
Body
Response: 200 OK
DELETE /api/departments/{id} 204 No Content

Delete Department

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

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