Placeholder REST API

v1.0.0

Generic Postman collection for UAT testing.

Authentication

4 endpoints

POST/v1/auth/registerRegister

lock

Requires Bearer token authentication.

Request body

application/json

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

Responses

Successful response

null

boltTry it

env

POSThttps://api.example.com/v1/v1/auth/register

Request body

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

Code samples

curl -X POST 'https://api.example.com/v1/v1/auth/register' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "John Doe",
  "email": "john@example.com",
  "password": "Password123"
}'

POST/v1/auth/loginLogin

lock

Requires Bearer token authentication.

Request body

application/json

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

Responses

Successful response

null

boltTry it

env

POSThttps://api.example.com/v1/v1/auth/login

Request body

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

Code samples

curl -X POST 'https://api.example.com/v1/v1/auth/login' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "email": "john@example.com",
  "password": "Password123"
}'

POST/v1/auth/refreshRefresh Token

Refresh Token

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

POSThttps://api.example.com/v1/v1/auth/refresh

Request body

Code samples

curl -X POST 'https://api.example.com/v1/v1/auth/refresh'

POST/v1/auth/logoutLogout

Logout

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

POSThttps://api.example.com/v1/v1/auth/logout

Request body

Code samples

curl -X POST 'https://api.example.com/v1/v1/auth/logout'

Users

7 endpoints

GET/v1/users/meGet Current User

Get Current User

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/users/me

Code samples

curl -X GET 'https://api.example.com/v1/v1/users/me'

PUT/v1/users/meUpdate Profile

Update Profile

lock

Requires Bearer token authentication.

Request body

application/json

{
  "name": "Updated Name"
}

Responses

Successful response

null

boltTry it

env

PUThttps://api.example.com/v1/v1/users/me

Request body

{
  "name": "Updated Name"
}

Code samples

curl -X PUT 'https://api.example.com/v1/v1/users/me' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "Updated Name"
}'

GET/v1/usersGet Users

Get Users

lock

Requires Bearer token authentication.

Parameters

pagequerystringdefault:

limitquerystringdefault:

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/users

Query parameters

page

limit

Code samples

curl -X GET 'https://api.example.com/v1/v1/users'

POST/v1/usersCreate User

Create User

lock

Requires Bearer token authentication.

Request body

application/json

{
  "name": "Jane",
  "email": "jane@example.com"
}

Responses

Successful response

null

boltTry it

env

POSThttps://api.example.com/v1/v1/users

Request body

{
  "name": "Jane",
  "email": "jane@example.com"
}

Code samples

curl -X POST 'https://api.example.com/v1/v1/users' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "Jane",
  "email": "jane@example.com"
}'

GET/v1/users/1Get User

Get User

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/users/1

Code samples

curl -X GET 'https://api.example.com/v1/v1/users/1'

PUT/v1/users/1Update User

Update User

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

PUThttps://api.example.com/v1/v1/users/1

Request body

Code samples

curl -X PUT 'https://api.example.com/v1/v1/users/1'

DELETE/v1/users/1Delete User

Delete User

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

DELETEhttps://api.example.com/v1/v1/users/1

Code samples

curl -X DELETE 'https://api.example.com/v1/v1/users/1'

Products

4 endpoints

GET/v1/productsGet Products

Get Products

lock

Requires Bearer token authentication.

Parameters

pagequerystringdefault:

limitquerystringdefault:

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/products

Query parameters

page

limit

Code samples

curl -X GET 'https://api.example.com/v1/v1/products'

POST/v1/productsCreate Product

Create Product

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

POSThttps://api.example.com/v1/v1/products

Request body

Code samples

curl -X POST 'https://api.example.com/v1/v1/products'

PUT/v1/products/123Update Product

Update Product

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

PUThttps://api.example.com/v1/v1/products/123

Request body

Code samples

curl -X PUT 'https://api.example.com/v1/v1/products/123'

DELETE/v1/products/123Delete Product

Delete Product

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

DELETEhttps://api.example.com/v1/v1/products/123

Code samples

curl -X DELETE 'https://api.example.com/v1/v1/products/123'

Orders

4 endpoints

GET/v1/ordersGet Orders

Get Orders

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/orders

Code samples

curl -X GET 'https://api.example.com/v1/v1/orders'

POST/v1/ordersCreate Order

Create Order

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

POSThttps://api.example.com/v1/v1/orders

Request body

Code samples

curl -X POST 'https://api.example.com/v1/v1/orders'

GET/v1/orders/1001Get Order

Get Order

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/orders/1001

Code samples

curl -X GET 'https://api.example.com/v1/v1/orders/1001'

PATCH/v1/orders/1001/cancelCancel Order

Cancel Order

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

PATCHhttps://api.example.com/v1/v1/orders/1001/cancel

Request body

Code samples

curl -X PATCH 'https://api.example.com/v1/v1/orders/1001/cancel'

File Upload

1 endpoint

POST/v1/uploadUpload File

Upload File

lock

Requires Bearer token authentication.

Request body

multipart/form-data

{
  "file": ""
}

Responses

Successful response

null

boltTry it

env

POSThttps://api.example.com/v1/v1/upload

Request body

{
  "file": ""
}

Code samples

curl -X POST 'https://api.example.com/v1/v1/upload' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "file": ""
}'

Reports

2 endpoints

GET/v1/reports/dashboardDashboard

Dashboard

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/reports/dashboard

Code samples

curl -X GET 'https://api.example.com/v1/v1/reports/dashboard'

GET/v1/reports/analyticsAnalytics

Analytics

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/reports/analytics

Code samples

curl -X GET 'https://api.example.com/v1/v1/reports/analytics'

System

2 endpoints

GET/v1/healthHealth

Health

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/health

Code samples

curl -X GET 'https://api.example.com/v1/v1/health'

GET/v1/versionVersion

Version

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/version

Code samples

curl -X GET 'https://api.example.com/v1/v1/version'

Notifications

2 endpoints

GET/v1/notificationsGet Notifications

Get Notifications

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/notifications

Code samples

curl -X GET 'https://api.example.com/v1/v1/notifications'

PATCH/v1/notifications/123/readMark Notification Read

Mark Notification Read

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

PATCHhttps://api.example.com/v1/v1/notifications/123/read

Request body

Code samples

curl -X PATCH 'https://api.example.com/v1/v1/notifications/123/read'

Settings for Replace

2 endpoints

GET/v1/settingsGet Settings

Get Settings

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

GEThttps://api.example.com/v1/v1/settings

Code samples

curl -X GET 'https://api.example.com/v1/v1/settings'

PUT/v1/settingsUpdate Settings

Update Settings

lock

Requires Bearer token authentication.

Responses

Successful response

null

boltTry it

env

PUThttps://api.example.com/v1/v1/settings

Request body

Code samples

curl -X PUT 'https://api.example.com/v1/v1/settings'

API

1 endpoint

GET/api/v1/usersCreating a user | New Summary

Creating a user | New Summary

Creates a new user account in the system.

The endpoint validates the request payload, checks for duplicate email addresses, hashes the user's password, and returns the newly created user object.

Authentication is required.

lock

Requires Bearer token authentication.

Headers

AuthorizationBearer {{token}}

Responses

New response

{
  "success": true,
  "message": "User created successfully.",
  "data": {
    "id": "65c82d1f9a0c1c3b9e012345",
    "name": "John Doe",
    "email": "john@example.com",
    "role": "user",
    "createdAt": "2026-07-20T12:00:00Z"
  }
}

boltTry it

env

GEThttps://api.example.com/v1/api/v1/users

Authorization

Authorization

Headers

Authorization

Code samples

curl -X GET 'https://api.example.com/v1/api/v1/users'