Admin

Tenant admin operations

Tenant admin login

post

/api/v1

/tenant-portal/login

Login to tenant portal

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Body

application/json

emailstring · emailOptional

passwordstringOptional

Responses

200

Successful login - Returns JWT token and user details

application/json

400

Bad request - Username or password is incorrect, or general error

application/json

401

Unauthorized - Account not found

application/json

500

Internal server error

post

/tenant-portal/login

HTTPcURLJavaScriptPython

POST /api/v1/tenant-portal/login HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "email": "[email protected]",
  "password": "text"
}

{
  "token": "text",
  "user": {}
}

Forgot password

post

/api/v1

/tenant-portal/forgot-password

Request password reset

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Body

application/json

emailstring · emailOptional

Responses

200

Password reset email sent - Returns confirmation message

application/json

400

Bad request - General error occurred

application/json

401

Unauthorized - Account not found

application/json

500

Internal server error

post

/tenant-portal/forgot-password

HTTPcURLJavaScriptPython

POST /api/v1/tenant-portal/forgot-password HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

An Email has been sent to you with instructions.

Reset password

post

/api/v1

/tenant-portal/reset-password

Reset password with token

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Body

application/json

emailstring · emailRequired

Email address of the account

tokenstringRequired

Password reset token

passwordstringRequired

New password

Responses

200

Password reset successful - Returns confirmation message

application/json

400

Bad request - General error occurred

application/json

401

Unauthorized - Account not found

application/json

500

Internal server error

post

/tenant-portal/reset-password

HTTPcURLJavaScriptPython

POST /api/v1/tenant-portal/reset-password HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "email": "[email protected]",
  "token": "text",
  "password": "text"
}

Your password has been successfully reset.