API Documentation

Comprehensive documentation for all available API endpoints and their usage.

Auth

Authentication

User authentication and authorization endpoints

POST/api/auth/login

User login endpoint

Response

{
  "status": 200,
  "body": {
    "token": "string",
    "user": {
      "id": "string",
      "email": "string",
      "name": "string"
    }
  }
}
POST/api/auth/register

User registration endpoint

Response

{
  "status": 201,
  "body": {
    "message": "User created successfully",
    "user": {
      "id": "string",
      "email": "string",
      "name": "string"
    }
  }
}
User

User Management

User profile and settings management

GET/api/users

Get all users

Response

{
  "status": 200,
  "body": {
    "users": [
      {
        "id": "string",
        "email": "string",
        "name": "string"
      }
    ]
  }
}
GET/api/users/:id

Get user by ID

Response

{
  "status": 200,
  "body": {
    "user": {
      "id": "string",
      "email": "string",
      "name": "string"
    }
  }
}