Employees API

v1.0 • REST • JSON

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

Quick Reference

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

Get All Employees

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

Get Single Employee

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

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

Employee Not Found

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

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

Create Employee

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

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

Update Employee

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

Delete Employee

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

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