Open Postman

Mock API

Beautifully designed backend verification for developers. Authentication enabled, fully documented, and ready for integration.

https://mock-api.flutteruniverse.dev/api/v1

🔐 Authentication

POST /auth/sign-up

Create a new user account. Returns user details and an access token to be used for subsequent requests.

Request Body

JSON
{
  "name": "John Doe",
  "email": "john@example.com",
  "password": "strongPassword123"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "User newly created successfully",
  "data": {
    "accessToken": "ey...",
    "needsPasswordChange": false
  }
}
POST /auth/login

Authenticate an existing user. Requires email and password.

Request Body

JSON
{
  "email": "john@example.com",
  "password": "strongPassword123"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "User logged in successfully",
  "data": {
    "accessToken": "ey...",
    "needsPasswordChange": false
  }
}
POST /auth/refresh-token 🔒

Generate a new access token using a refresh token.

Request Body

JSON
{
  "cookies": {
     "refreshToken": "..."
  }
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "New access token generated successfully",
  "data": {
    "accessToken": "ey..."
  }
}
POST /auth/change-password 🔒

Change the current user's password.

Request Body

JSON
{
  "oldPassword": "strongPassword123",
  "newPassword": "newStrongPassword456"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Password changed successfully"
}
POST /auth/forgot-password

Initiate password reset flow.

Request Body

JSON
{
  "email": "john@example.com"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Reset link sent to email"
}
POST /auth/verify-email

Verify email address using a one-time code.

Request Body

JSON
{
  "email": "john@example.com",
  "oneTimeCode": "123456"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Email verified successfully"
}
POST /auth/reset-password

Reset the password using a verified token/code.

Request Body

JSON
{
  "email": "john@example.com",
  "newPassword": "newStrongPassword789",
  "token": "reset_token_here"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Password reset successfully"
}
DELETE /auth/delete-account 🔒

Permanently delete the user account.

Request Body

JSON
{
  "password": "currentPassword123"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Account deleted successfully"
}

👤 Users

GET /user/profile 🔒

Retrieve the profile information of the currently logged-in user.

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Profile retrieved successfully",
  "data": {
    "_id": "651a...",
    "name": "John Doe",
    "email": "john@example.com",
    "image": "..."
  }
}
PATCH /user/profile 🔒

Update the current user's profile information.

Request Body

JSON
{
  "name": "John Updated",
  "image": "https://example.com/new-pic.jpg"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Profile updated successfully",
  "data": {
    "name": "John Updated",
    ...
  }
}
GET /user/:id 🔒

Get public information of a specific user by their ID.

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "User retrieved successfully",
  "data": {
    "_id": "651a...",
    "name": "Jane Doe",
    "email": "jane@example.com"
  }
}
GET /users 🔒

Get a list of all users.

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Users retrieved successfully",
  "data": [
    { "name": "User 1", ... },
    { "name": "User 2", ... }
  ]
}

📝 Posts

POST /post/ 🔒

Create a new post.

Request Body

JSON
{
  "description": "My first post on this platform!",
  "image": "https://example.com/post.jpg"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Post created successfully",
  "data": {
    "_id": "...",
    "description": "My first post...",
    "userId": "..."
  }
}
GET /posts/

Get all posts. This is a public endpoint.

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Posts retrieved successfully",
  "data": [
    { "description": "Post 1", ... },
    { "description": "Post 2", ... }
  ]
}
GET /post/:id

Get a single post by ID.

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Post retrieved successfully",
  "data": {
    "_id": "...",
    "description": "..."
  }
}

💬 Comments

POST /comment/ 🔒

Add a comment to a post.

Request Body

JSON
{
  "postId": "651a...",
  "comment": "This is a great post!"
}

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Comment created successfully",
  "data": { ... }
}
GET /comment/:id

Get a single comment by ID.

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Comment retrieved successfully",
  "data": {
    "_id": "...",
    "comment": "This is a great post!",
    "postId": "..."
  }
}
GET /comments/

Get all comments.

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Comments retrieved successfully",
  "data": [ ... ]
}

📁 File Uploads

POST /file/ 🔒

Upload a single file (image).

Request Type

multipart/form-data

Field name: image

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "File stored successfully",
  "data": "url_to_image"
}
POST /file/multiple 🔒

Upload multiple files.

Request Type

multipart/form-data

Field name: image (multiple)

Success Response (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Files stored successfully",
  "data": [ "url1", "url2" ]
}