Skip to main content

API Contracts

This document outlines the API endpoints and expected request/response contracts for the User Profile Management module.

1. Get User Profile

  • Endpoint: /api/v1/users/{userId}
  • Method: GET
  • Description: Retrieves the profile details for a specific user.
  • Authentication: Required (JWT Token)

Request (Path Parameters)

ParameterTypeDescription
userIdstringThe ID of the user.

Response (200 OK)

{
  "id": "user123",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phoneNumber": "+919876543210",
  "preferences": {
    "notifications": {
      "email": true,
      "sms": false
    }
  },
  "createdAt": "2023-01-15T10:00:00Z",
  "updatedAt": "2024-06-20T14:30:00Z"
}