API Reference

Complete REST API documentation for the Minima+ example API

Overview

This API provides a RESTful interface for managing users. All endpoints require authentication via Bearer token.

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.example.com/v1/users

Rate Limiting

  • Rate limit: 100 requests per minute
  • Headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Error Handling

All errors return a consistent JSON structure:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": []
  }
}
GET /users Auth Required

List all users with optional filtering and pagination

Parameters

Name Type In Description
page integer query Page number for pagination
limit integer query Number of results per page
status string query Filter by user status (active, inactive, pending)

Responses

200 Successful response
401 Unauthorized - Invalid or missing token
GET /users/:id Auth Required

Get a specific user by their unique ID

Parameters

Name Type In Description
id * string path The unique user identifier

Responses

200 User found
404 User not found
POST /users Auth Required

Create a new user account

Parameters

Name Type In Description
email * string body User's email address
name * string body User's full name
role string body User role (admin, user, guest)

Responses

201 User created successfully
400 Invalid request body
409 Email already exists
PUT /users/:id Auth Required

Update an existing user's information

Parameters

Name Type In Description
id * string path The unique user identifier
name string body Updated name
email string body Updated email

Responses

200 User updated
404 User not found
DELETE /users/:id Auth Required

Delete a user account permanently

Parameters

Name Type In Description
id * string path The unique user identifier

Responses

204 User deleted
404 User not found