Users API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Users

Retrieves a paginated list of all users 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
Headers
Response: 200 OK
GET /api/users/{id} 200 OK

Get Single User

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

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

User Not Found

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

Headers
Response: 404 Not Found
POST /api/users 201 Created

Create User

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

Request Body
Field Type Required Description
firstName string Required First name
lastName string Required Last name
email string Required Email
password string Required Password
roleIds integer[] Optional Role ids
Response: 201 Created
PUT /api/users/{id} 200 OK

Update User

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

Request Body
Field Type Required Description
firstName string Required First name
lastName string Required Last name
email string Required Email
roleIds integer[] Optional Role ids
Response: 200 OK
DELETE /api/users/{id} 204 No Content

Delete User

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

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