MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our Auth n Auth API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token using Get Token.
If not a registered user Register.

Auth'N'Auth API Endpoints

API Access User - Register

Used to register the API Access User

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Tony Hanks\",
    \"username\": \"tonyhanks\",
    \"email\": \"tony@example.com\",
    \"password\": \"UGFzc3dvcmRAMTIz\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Tony Hanks",
    "username": "tonyhanks",
    "email": "tony@example.com",
    "password": "UGFzc3dvcmRAMTIz"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/register

Body Parameters

name  string  

Name of the API Access User

username  string  

Username of the API Access User

email  string  

Email of the API Access User

password  string  

Base64 Encoded Password of the API Access User.

API Access User - Get Token

Used to authenticate User parameter and get token using the same

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/get_token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"james\",
    \"password\": \"UGFzc3dvcmRAMTIz\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/get_token"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "james",
    "password": "UGFzc3dvcmRAMTIz"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/get_token

Body Parameters

username  string  

Username of the API Access User.

password  string  

Base64 Encoded Password of the API Access User.

Content API Endpoints

Content - Get FAQ

requires authentication

Used to Get FAQ List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/content/v1/faq" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"keyword\": \"Token amount details\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/content/v1/faq"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "keyword": "Token amount details"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/faq

Body Parameters

keyword  string optional  

Keyword to be searched in question, answer.

Content - CMS Page

requires authentication

Used to get cms page list

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/content/v1/cms_page" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page_slug\": \"about\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/content/v1/cms_page"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "page_slug": "about"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/cms_page

Body Parameters

page_slug  optional optional  

select about,terms-conditions,privacy page_slug for cms page

Content - CMS Home

requires authentication

Used to get cms home

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/content/v1/cms_home" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"city_id\": \"256\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/content/v1/cms_home"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "city_id": "256"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/cms_home

Body Parameters

city_id  required optional  

city_id to fetch the cms home

Content - Blogs News List

requires authentication

Used to get blogs news list

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/content/v1/blogs_news" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/content/v1/blogs_news"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/blogs_news

Body Parameters

limit  number optional  

offset  number optional  

requires authentication

Used to get footer content

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/content/v1/footer_content" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/content/v1/footer_content"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Content - Career Vacancy List

requires authentication

Used to get Career Vacancy List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/content/v1/careers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/content/v1/careers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/careers

Body Parameters

limit  number optional  

offset  number optional  

search_key  string optional  

optional search_key to be searched in position

Content - Career Vacancy Details

requires authentication

Used to get career vacancy details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/content/v1/career_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"career_id\": null,
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/content/v1/career_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "career_id": null,
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/career_details

Body Parameters

career_id  integer  

career_id for career vacancy details

limit  number optional  

offset  number optional  

Content - Career Job Application

requires authentication

Used to get career job application

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/content/v1/career_application" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "career_id=" \
    --form "name=" \
    --form "email=" \
    --form "mobile=" \
    --form "resume=@C:\Users\Dell\AppData\Local\Temp\php2899.tmp" 
const url = new URL(
    "https://api.qa.blox.co.in/content/v1/career_application"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('career_id', '');
body.append('name', '');
body.append('email', '');
body.append('mobile', '');
body.append('resume', document.querySelector('input[name="resume"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST v1/career_application

Body Parameters

career_id  integer  

career_id for job application

name  string  

name for job application

email  string  

email for job application

mobile  string  

mobile for job application

link  string optional  

optional linkedin or portfolio links for job application

resume  file  

resume [format : 'pdf'] size up to 5 MB Example:

Customer API Endpoints

Customer - Signup

requires authentication

Used to Signup

Example request:
curl --request POST \
                "https://api.qa.blox.co.in/auth/v1/signup" \
                --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
                --header "Content-Type: application/json" \
                --header "Accept: application/json" \
                --data "{
                \"email\": \"tony@example.com\",
                \"mobile\": \"9087654321\",
                \"country_code\": \"91\",
                \"name\": \"Tony Hanks\",
                \"location\": \"Mumbai\",
                \"user_type\": \"customer\"
            }"
            
const url = new URL(
                "https://api.qa.blox.co.in/auth/v1/signup"
            );

            const headers = {
                "Authorization": "Bearer {YOUR_AUTH_KEY}",
                "Content-Type": "application/json",
                "Accept": "application/json",
            };

            let body = {
                "email": "tony@example.com",
                "mobile": "9087654321",
                "country_code": "91",
                "name": "Tony Hanks",
                "location": "Mumbai",
                "user_type": "customer"
            };

            fetch(url, {
                method: "POST",
                headers,
                body: JSON.stringify(body),
            }).then(response => response.json());

Request      

POST v1/signup

Body Parameters

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

name  string  

Name of the Customer

location  string  

Location of the Customer

user_type  string optional  

User Type['cp', 'customer', 'developer'] Will be treated as customer if no data provided

device  string optional  

Enter the Device info (example:- {"deviceToken": "xxxxxxxxxxxxxxxxx","deviceId": "9BDD22D9-54B8-4BF8-B3AD-A20314D5C84E", "deviceInfo": "iPhone 12 mini (iOS 15.4.1)", "deviceType": "IOS"} )

created_by_id  integer optional  

Enter created by Id (while the rm or cp add the customer here we need to pass rm_id or cp_id)

created_by_user_type  string optional  

Enter created_by user type (rm and cp)

user_id  integer optional  

Enter user id

Customer - Signin

requires authentication

Used to Signin

Example request:
curl --request POST \
                    "https://api.qa.blox.co.in/auth/v1/signin" \
                    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
                    --header "Content-Type: application/json" \
                    --header "Accept: application/json" \
                    --data "{
                    \"username\": \"tony@example.com\",
                    \"user_type\": \"customer\"
                }"
                
const url = new URL(
                    "https://api.qa.blox.co.in/auth/v1/signin"
                );

                const headers = {
                    "Authorization": "Bearer {YOUR_AUTH_KEY}",
                    "Content-Type": "application/json",
                    "Accept": "application/json",
                };

                let body = {
                    "username": "tony@example.com",
                    "user_type": "customer"
                };

                fetch(url, {
                    method: "POST",
                    headers,
                    body: JSON.stringify(body),
                }).then(response => response.json());

Request      

POST v1/signin

Body Parameters

username  string  

Username of the Customer

user_type  string optional  

User Type['cp', 'customer', 'developer'] Will be treated as customer if no data provided

device  string optional  

Enter the Device info (example:- {"deviceToken": "xxxxxxxxxxxxxxxxx","deviceId": "9BDD22D9-54B8-4BF8-B3AD-A20314D5C84E", "deviceInfo": "iPhone 12 mini (iOS 15.4.1)", "deviceType": "IOS"} )

Customer - Send-OTP

requires authentication

Used to Send OTP

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/send_otp" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"john@example.com\",
    \"mobile\": \"9087654321\",
    \"country_code\": \"91\",
    \"whatsapp_flag\": \"0\",
    \"device_id\": \"a2gdf3hh3\",
    \"user_type\": \"customer\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/send_otp"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "john@example.com",
    "mobile": "9087654321",
    "country_code": "91",
    "whatsapp_flag": "0",
    "device_id": "a2gdf3hh3",
    "user_type": "customer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/send_otp

Body Parameters

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

whatsapp_flag  numeric optional  

Whatsapp Flag

device_id  string optional  

Device Id(mandatory in case of cp)

user_type  string optional  

User Type['cp', 'customer', 'developer'] Will be treated as customer if no data provided

Customer - Verify-OTP

requires authentication

Used to Verify OTP

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/verify_otp" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"otp\": \"1234\",
    \"email\": \"john@example.com\",
    \"mobile\": \"9087654321\",
    \"country_code\": \"91\",
    \"user_type\": \"customer\",
    \"device_id\": \"a2gdf3hh3\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/verify_otp"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "otp": "1234",
    "email": "john@example.com",
    "mobile": "9087654321",
    "country_code": "91",
    "user_type": "customer",
    "device_id": "a2gdf3hh3"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/verify_otp

Body Parameters

otp  numeric  

OTP of the Customer

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

user_type  string optional  

User Type['cp', 'customer', 'developer'] Will be treated as customer if no data provided

device_id  string optional  

Device Id

Customer - User Exist

requires authentication

Used to User Exist

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/user_exist" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"john@example.com\",
    \"mobile\": \"9087654321\",
    \"country_code\": \"91\",
    \"user_type\": \"customer\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/user_exist"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "john@example.com",
    "mobile": "9087654321",
    "country_code": "91",
    "user_type": "customer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/user_exist

Body Parameters

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

user_type  string optional  

Enter user type

Customer - Logout

requires authentication

Used to Logout

Example request:
curl --request POST \
            "https://api.qa.blox.co.in/auth/v1/user/logout" \
            --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --data "{
            \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
            \"user_type\": \"customer\"
        }"
        
const url = new URL(
            "https://api.qa.blox.co.in/auth/v1/user/logout"
        );

        const headers = {
            "Authorization": "Bearer {YOUR_AUTH_KEY}",
            "Content-Type": "application/json",
            "Accept": "application/json",
        };

        let body = {
            "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
            "user_type": "customer"
        };

        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

Request      

POST v1/user/logout

Body Parameters

ctoken  string  

Customer token

user_type  string optional  

Enter user type

Customer - Verify Social Login Token

requires authentication

Used to Verify Social Login Token

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/verify_social_login_token" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"social_type\": \"google\",
    \"social_token\": \"sdafsdjfasdjhx53kshdkasdhfkashdfks\",
    \"user_type\": \"customer\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/verify_social_login_token"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "social_type": "google",
    "social_token": "sdafsdjfasdjhx53kshdkasdhfkashdfks",
    "user_type": "customer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/verify_social_login_token

Body Parameters

social_type  string  

Email of the Customer

social_token  string  

Social Token of the Customer

user_type  string optional  

User Type of the Customer

Customer - Mark Property Viewed

requires authentication

Used to Mark Property Viewed

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/mark_property_viewed" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": \"38,3\",
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"guest_id\": \"sjkjshakjsd\",
    \"city_id\": 300
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/mark_property_viewed"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": "38,3",
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "guest_id": "sjkjshakjsd",
    "city_id": 300
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/mark_property_viewed

Body Parameters

project_id  string  

Project IDs of the project (Here you can pass the product_id as array or comma separted [38,3])

ctoken  string  

Customer token

guest_id  string optional  

Guest id (unique)

city_id  number optional  

City id is belong to property

Customer - Update Profile

requires authentication

Used to Update Profile

Example request:
curl --request POST \
            "https://api.qa.blox.co.in/customer/v1/update/user/details" \
            --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
            --header "Content-Type: multipart/form-data" \
            --header "Accept: application/json" \
            --form "ctoken=e7ff6070baaa30946ad195e7ea678e9e" \
            --form "name=john" \
            --form "email=john@example.com" \
            --form "mobile=9087654321" \
            --form "country_code=91" \
            --form "alt_phone_country=91" \
            --form "profile_pic=@/tmp/phpBTUJIw" 
const url = new URL(
            "https://api.qa.blox.co.in/customer/v1/update/user/details"
        );
        
        const headers = {
            "Authorization": "Bearer {YOUR_AUTH_KEY}",
            "Content-Type": "multipart/form-data",
            "Accept": "application/json",
        };
        
        const body = new FormData();
        body.append('ctoken', 'e7ff6070baaa30946ad195e7ea678e9e');
        body.append('name', 'john');
        body.append('email', 'john@example.com');
        body.append('mobile', '9087654321');
        body.append('country_code', '91');
        body.append('alt_phone_country', '91');
        body.append('profile_pic', document.querySelector('input[name="profile_pic"]').files[0]);
        
        fetch(url, {
            method: "POST",
            headers,
            body,
        }).then(response => response.json());

Request      

POST v1/update/user/details

Body Parameters

ctoken  string optional  

Customer token

customer_id  integer optional  

Enter customer_id only for rm case

name  string  

Name of the Customer

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

alternate_email  string optional  

Enter customer address

alternate_mobile  numeric optional  

Enter customer address

alt_phone_country  numeric  

Country Code of the Customer

address  string optional  

Enter customer address

city_id  integer optional  

Enter customer City id

state_id  integer optional  

Enter customer State id

country_id  integer optional  

Enter customer country id

pincode  string optional  

Enter customer pincode

profile_pic  file  

profile pic[format : 'png', 'jpeg', 'jpg'] Example:

age  integer optional  

age of the Customer

gender  integer optional  

gender of the Customer (1=Male | 2= Female)

industry  integer optional  

industry of the Customer

organization  string optional  

organization of the Customer

occupation  integer optional  

occupation id of the Customer

designation  integer optional  

designation id of the Customer

highest_education  integer optional  

highest_education id of the Customer

current_residence  string optional  

current_residence of the Customer

family_size  integer optional  

family_size of the Customer

ethnicity  integer optional  

ethnicity of the Customer

marital_status  string optional  

marital_status of the Customer(1=Married | 2= Unmarried)

Customer - Viewed Properties

requires authentication

Used to Viewed Properties

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/property/v1/viewed/properties" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/viewed/properties"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/viewed/properties

Body Parameters

ctoken  string  

Customer token

limit  number optional  

Limit

offset  number optional  

Offset

Customer - My Meetings

requires authentication

Used to My Meetings

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/my_meetings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/my_meetings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/my_meetings

Body Parameters

ctoken  string  

Customer token

limit  number optional  

Limit

offset  number optional  

Offest

Customer - generate Customer lead non eoi

requires authentication

generate Customer lead non eoi

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/generate-lead-non-eoi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 39,
    \"property_tower_id\": 147,
    \"ctoken\": \"76e18e2f51bb738291b7dc945d92e7f7\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/generate-lead-non-eoi"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": 39,
    "property_tower_id": 147,
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/generate-lead-non-eoi

Body Parameters

project_id  integer  

Project Id

property_tower_id  integer  

Id Of Project Tower Property

ctoken  string optional  

Customer token

Customer - List of Application sources

requires authentication

List of Application sources

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/customer/v1/user-sources" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/user-sources"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/user-sources

Customer - Customer Profile

requires authentication

Getting Customer Profile

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/get_profile_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"76e18e2f51bb738291b7dc945d92e7f7\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/get_profile_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/get_profile_details

Body Parameters

ctoken  string optional  

Customer token

Customer - Master Data List

requires authentication

Getting Master Data

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/customer_profilemasterdata" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"76e18e2f51bb738291b7dc945d92e7f7\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/customer_profilemasterdata"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/customer_profilemasterdata

Body Parameters

ctoken  string optional  

Customer token

Favourite List

requires authentication

Used to get favourite list

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/favourite_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 33549,
    \"tab\": \"my_property\",
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/favourite_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 33549,
    "tab": "my_property",
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/favourite_list

Body Parameters

user_id  number  

user_id for favourite list

tab  string optional  

tab for My Property

limit  number optional  

offset  number optional  

Add Favourite

requires authentication

Used to add favourite

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/add_favourite" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 33549,
    \"project_id\": [
        22,
        35
    ]
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/add_favourite"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 33549,
    "project_id": [
        22,
        35
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/add_favourite

Body Parameters

user_id  number  

user_id for add favourite

project_id  object  

project_id for add favourite

Customer - Remove Favourite

requires authentication

Used to Remove Favourite

Example request:
curl --request POST \
            "https://api.qa.blox.co.in/customer/v1/remove_favourite" \
            --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --data "{
            \"ctoken\": \"incidunt\",
            \"customer_id\": \"minima\",
            \"project_id\": \"22\"
        }"
        
const url = new URL(
            "https://api.qa.blox.co.in/customer/v1/remove_favourite"
        );
        
        const headers = {
            "Authorization": "Bearer {YOUR_AUTH_KEY}",
            "Content-Type": "application/json",
            "Accept": "application/json",
        };
        
        let body = {
            "ctoken": "incidunt",
            "customer_id": "minima",
            "project_id": "22"
        };
        
        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

Request      

POST v1/remove_favourite

Body Parameters

ctoken  string optional  

Customer token Enter either ctoken or customer id

customer_id  string optional  

Customer ID Example:

project_id  numeric  

Project ID of the project

Customer API V2 Endpoints

Customer - Signin

requires authentication

Used to Signin

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v2/signin" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"tony@example.com\",
    \"user_type\": \"customer\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v2/signin"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "tony@example.com",
    "user_type": "customer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/signin

Body Parameters

username  string  

Username of the Customer

user_type  string optional  

User Type['cp', 'customer', 'developer'] Will be treated as customer if no data provided

device  string optional  

Enter the Device info (example:- {"deviceToken": "xxxxxxxxxxxxxxxxx","deviceId": "9BDD22D9-54B8-4BF8-B3AD-A20314D5C84E", "deviceInfo": "iPhone 12 mini (iOS 15.4.1)", "deviceType": "IOS"} )

Customer - Re-Send-OTP

requires authentication

Used to re-send OTP

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v2/send_otp" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"john@example.com\",
    \"mobile\": \"9087654321\",
    \"country_code\": \"91\",
    \"whatsapp_flag\": \"0\",
    \"device_id\": \"a2gdf3hh3\",
    \"user_type\": \"customer\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v2/send_otp"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "john@example.com",
    "mobile": "9087654321",
    "country_code": "91",
    "whatsapp_flag": "0",
    "device_id": "a2gdf3hh3",
    "user_type": "customer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/send_otp

Body Parameters

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

whatsapp_flag  numeric optional  

Whatsapp Flag

device_id  string optional  

Device Id(mandatory in case of cp)

user_type  string optional  

User Type['cp', 'customer', 'developer'] Will be treated as customer if no data provided

Customer - Verify-OTP

requires authentication

Used to Verify OTP

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v2/verify_otp" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"otp\": \"1234\",
    \"email\": \"john@example.com\",
    \"mobile\": \"9087654321\",
    \"country_code\": \"91\",
    \"user_type\": \"customer\",
    \"device_id\": \"a2gdf3hh3\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v2/verify_otp"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "otp": "1234",
    "email": "john@example.com",
    "mobile": "9087654321",
    "country_code": "91",
    "user_type": "customer",
    "device_id": "a2gdf3hh3"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/verify_otp

Body Parameters

otp  numeric  

OTP of the Customer

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

user_type  string optional  

User Type['cp', 'customer', 'developer'] Will be treated as customer if no data provided

device_id  string optional  

Device Id

Enquiry API Endpoints

Enquiry - Contact RM

requires authentication

Used to Contact RM

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/enquiry/v1/contact_rm" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"tony@example.com\",
    \"mobile\": \"9087654321\",
    \"country_code\": \"+91\",
    \"name\": \"Tony Hanks\",
    \"content\": \"want to contact\",
    \"project_id\": 8
}"
const url = new URL(
    "https://api.qa.blox.co.in/enquiry/v1/contact_rm"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "tony@example.com",
    "mobile": "9087654321",
    "country_code": "+91",
    "name": "Tony Hanks",
    "content": "want to contact",
    "project_id": 8
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/contact_rm

Body Parameters

email  string  

Email of the User

mobile  numeric  

Mobile of the User

country_code  numeric  

Country Code of the User

name  string  

Name of the User

content  string optional  

Message for request

project_id  number  

Location of the User

Enquiry - Book a Visit

requires authentication

Used to Book a Visit

Example request:
curl --request POST \
            "https://api.qa.blox.co.in/enquiry/v1/book_visit" \
            --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --data "{
            \"email\": \"tony@example.com\",
            \"mobile\": \"9087654321\",
            \"country_code\": \"91\",
            \"name\": \"Tony Hanks\",
            \"project_id\": 8,
            \"date\": \"2023-12-1 12:12:58\",
            \"visit_type\": 1,
            \"webinar_id\": 0,
            \"is_homeloan\": false,
            \"pdf_id\": false
        }"
        
const url = new URL(
            "https://api.qa.blox.co.in/enquiry/v1/book_visit"
        );

        const headers = {
            "Authorization": "Bearer {YOUR_AUTH_KEY}",
            "Content-Type": "application/json",
            "Accept": "application/json",
        };

        let body = {
            "email": "tony@example.com",
            "mobile": "9087654321",
            "country_code": "91",
            "name": "Tony Hanks",
            "project_id": 8,
            "date": "2023-12-1 12:12:58",
            "visit_type": 1,
            "webinar_id": 0,
            "is_homeloan": false,
            "pdf_id": false
        };

        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

Request      

POST v1/book_visit

Body Parameters

email  string  

Email of the User

mobile  numeric  

Mobile of the User

country_code  numeric  

Country Code of the User

name  string  

Name of the User

project_id  number  

Enter project Id

date  datetime  

Enter datetime for visit schedule

visit_type  number  

Enter Visit Type (1=Physically Visit OR 2=Virtually Visit)

webinar_id  number optional  

Enter webinar Id (This is for backend use)

is_homeloan  boolean optional  

Select for Home loan requirment (This is for backend use)

pdf_id  boolean optional  

Select for PDF download Example (This is for backend use): false

Enquiry - Reschedule Meeting

requires authentication

Used to Reschedule Meeting

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/enquiry/v1/reschedule_meeting" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"33550\",
    \"mobile\": \"7503453964\",
    \"country_code\": \"+91\",
    \"project_id\": 8,
    \"visit_date\": \"2023-12-1\",
    \"visit_time\": \"17:05:01\",
    \"visit_type\": 1,
    \"type\": 3
}"
const url = new URL(
    "https://api.qa.blox.co.in/enquiry/v1/reschedule_meeting"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "33550",
    "mobile": "7503453964",
    "country_code": "+91",
    "project_id": 8,
    "visit_date": "2023-12-1",
    "visit_time": "17:05:01",
    "visit_type": 1,
    "type": 3
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/reschedule_meeting

Body Parameters

user_id  numeric  

Mobile of the User

mobile  numeric  

Mobile of the User

country_code  numeric  

Country Code of the User

project_id  number  

Enter project Id

visit_date  date  

Enter date for re-schedule

visit_time  time  

Enter date for re-schedule

visit_type  number  

Enter Visit Type

type  number optional  

Enter Type

Enquiry - Lead Capture

requires authentication

Used to Lead Capture

Example request:
curl --request POST \
            "https://api.qa.blox.co.in/enquiry/v1/lead_capture" \
            --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --data "{
            \"name\": \"Tony Hanks\",
            \"email\": \"tony@example.com\",
            \"mobile\": \"9087654321\",
            \"country_code\": \"91\",
            \"project_banners_id\": 2,
            \"project_id\": 7,
            \"lead_source\": 86
        }"
        
const url = new URL(
            "https://api.qa.blox.co.in/enquiry/v1/lead_capture"
        );
        
        const headers = {
            "Authorization": "Bearer {YOUR_AUTH_KEY}",
            "Content-Type": "application/json",
            "Accept": "application/json",
        };
        
        let body = {
            "name": "Tony Hanks",
            "email": "tony@example.com",
            "mobile": "9087654321",
            "country_code": "91",
            "project_banners_id": 2,
            "project_id": 7,
            "lead_source": 86
        };
        
        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

Request      

POST v1/lead_capture

Body Parameters

name  string  

Name of the contact us

email  string  

Email of the contact us

mobile  numeric  

Mobile of the contact us

country_code  numeric  

Country Code of the contact us

project_banners_id  integer  

Enter banner id of particular project

project_id  integer  

Enter project id

lead_source  integer  

Enter lead source id

microsite_action  string optional  

Possible values: download_brochure / microsite_call_rm / book_a_site_visit / book_now

Enquiry - Contact Us

requires authentication

Used to contact us

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/enquiry/v1/contact_us" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Tony Hanks\",
    \"country_code\": \"+91\",
    \"mobile\": \"9087654321\",
    \"email\": \"tony@example.com\",
    \"message\": \"want to contact\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/enquiry/v1/contact_us"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Tony Hanks",
    "country_code": "+91",
    "mobile": "9087654321",
    "email": "tony@example.com",
    "message": "want to contact"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/contact_us

Body Parameters

name  string  

Name of the contact us

country_code  numeric  

Country Code of the contact us

mobile  numeric  

Mobile of the contact us

email  string  

Email of the contact us

message  string  

Message for request

Property API OLD Endpoints

Get Settings

requires authentication

Used to get Website Settings

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/auth/v1/get_website_settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/get_website_settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/get_website_settings

Property - Save Filters

requires authentication

Used to Save Filters

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/save_filters" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_id\": \"2\",
    \"name\": \"assumenda\",
    \"location_ids\": [
        3,
        1
    ],
    \"developer_ids\": [
        4,
        3
    ],
    \"project_type_ids\": [
        \"similique\"
    ],
    \"property_type_ids\": [
        1,
        5
    ],
    \"configuration\": [
        \"libero\"
    ],
    \"amenities\": [
        29,
        31
    ],
    \"no_of_bathrooms\": [
        2,
        3
    ],
    \"area\": [
        
    ],
    \"city_id\": \"256\",
    \"budget_min\": 5000000,
    \"budget_max\": 25500000,
    \"construction_statuses\": [
        1,
        2
    ],
    \"top_property\": true,
    \"fast_selling\": true,
    \"blox_assured\": true,
    \"blox_exclusive\": true,
    \"is_trending\": true,
    \"is_featured\": true,
    \"is_popular\": true,
    \"is_verified\": true,
    \"is_gated_community\": true
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/save_filters"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "customer_id": "2",
    "name": "assumenda",
    "location_ids": [
        3,
        1
    ],
    "developer_ids": [
        4,
        3
    ],
    "project_type_ids": [
        "similique"
    ],
    "property_type_ids": [
        1,
        5
    ],
    "configuration": [
        "libero"
    ],
    "amenities": [
        29,
        31
    ],
    "no_of_bathrooms": [
        2,
        3
    ],
    "area": [
        
    ],
    "city_id": "256",
    "budget_min": 5000000,
    "budget_max": 25500000,
    "construction_statuses": [
        1,
        2
    ],
    "top_property": true,
    "fast_selling": true,
    "blox_assured": true,
    "blox_exclusive": true,
    "is_trending": true,
    "is_featured": true,
    "is_popular": true,
    "is_verified": true,
    "is_gated_community": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/save_filters

Body Parameters

customer_id  required optional  

customer_id for save filter

name  string  

location_ids  object[] optional  

developer_ids  object[] optional  

project_type_ids  string[] optional  

property_type_ids  object[] optional  

configuration  string[] optional  

amenities  object[] optional  

no_of_bathrooms  object[] optional  

area  object[] optional  

city_id  string  

City_id for which the properties need to be searched.

budget_min  integer optional  

budget_max  integer optional  

construction_statuses  object[] optional  

top_property  boolean optional  

fast_selling  boolean optional  

blox_assured  boolean optional  

blox_exclusive  boolean optional  

is_trending  boolean optional  

is_featured  boolean optional  

is_popular  boolean optional  

is_verified  boolean optional  

is_gated_community  boolean optional  

Property - Get Saved Filters

requires authentication

Used to Get Saved Filters

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/get_saved_filters" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_id\": \"3\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/get_saved_filters"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "customer_id": "3"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/get_saved_filters

Body Parameters

customer_id  required optional  

customer_id for save filter

Customer - Remove Filters

requires authentication

Used to Remove Filters

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/delete_saved_filters" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"filter_id\": \"3\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/delete_saved_filters"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "filter_id": "3"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/delete_saved_filters

Body Parameters

ctoken  required optional  

Enter customer token

filter_id  required optional  

Enter filter id

Customer - Booked Properties List

requires authentication

fetches booked properties list based on role

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/customer/v1/booked-properties?user_id=33567&user_type=customer&limit=100&offset=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 10,
    \"user_type\": \"et\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/booked-properties"
);

const params = {
    "user_id": "33567",
    "user_type": "customer",
    "limit": "100",
    "offset": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 10,
    "user_type": "et"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v1/booked-properties

Query Parameters

user_id  number  

User Id

user_type  string  

User Type[customer, cp, rm]

limit  number optional  

offset  number optional  

Customer - Visited Properties List

requires authentication

fetches visited properties list

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/customer/v1/visited-properties?ctoken=76e18e2f51bb738291b7dc945d92e7f7&limit=10&offset=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"temporibus\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/visited-properties"
);

const params = {
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7",
    "limit": "10",
    "offset": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "temporibus"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v1/visited-properties

Query Parameters

ctoken  string  

Customer token

limit  number optional  

offset  number optional  

POST v1/stamp_duty_master_data_api

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/customer/v1/stamp_duty_master_data_api" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/stamp_duty_master_data_api"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST v1/stamp_duty_master_data_api

Property API Endpoints

Property - Relevance Sort Options

requires authentication

Used to get relevance sort options for property

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/relevance_sort_options" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/relevance_sort_options"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/relevance_sort_options

Property - Budget Options

requires authentication

Used to get budget options for property

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/budget_options" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/budget_options"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/budget_options

Property - Property Type

requires authentication

Used to get property type

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/property_type" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/property_type"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/property_type

Property - Amenities

requires authentication

Used to get amenities in property

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/amenities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/amenities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/amenities

Property - Construction Status

requires authentication

Used to get construction status of a property

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/construction_status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/construction_status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/construction_status

Property - Config List (BHK Types)

requires authentication

Used to get BHK types for property

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/config_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/config_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/config_list

Property - Property Area

requires authentication

Used to get property area for property

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/property_area" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/property_area"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/property_area

Property - Master Data

requires authentication

Used to get master data for property

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/master_data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/master_data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/master_data

Property - City List

requires authentication

Used to get city list

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/city_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/city_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/city_list

Property - Location List

requires authentication

Used to get location list

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/location_list?city_id=256" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/location_list"
);

const params = {
    "city_id": "256",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/location_list

Query Parameters

city_id  number  

City_id for which the location needs to be fetched.

requires authentication

Used to get keyword based search for location, project, developer

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/property/v1/keyword_search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"keyword\": \"godrej\",
    \"city_id\": 256,
    \"developer\": true,
    \"location\": true,
    \"project\": false
}"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/keyword_search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "keyword": "godrej",
    "city_id": 256,
    "developer": true,
    "location": true,
    "project": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Property - List Hot Properties

requires authentication

Use to get list of hot properties with property tags and other essential informations

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/property_list?city_id=256" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/property_list"
);

const params = {
    "city_id": "256",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/property_list

Query Parameters

city_id  number  

City_id for which the properties need to be fetched.

Property - Near You

requires authentication

Use to get list of properties near you according to the city_id provided

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/property/v1/properties_near_you?city_id=256" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/properties_near_you"
);

const params = {
    "city_id": "256",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/properties_near_you

Query Parameters

city_id  number  

City_id for which the properties need to be fetched.

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/property/v1/property_search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"segments\": \"\\/filters\\/mumbai\\/builders-developers?developer=9%2C32%2C33\",
    \"city_id\": 256,
    \"location_ids\": [
        3,
        1
    ],
    \"developer_ids\": [
        4,
        3,
        8,
        12,
        19
    ],
    \"budget_min\": 5000000,
    \"budget_max\": 25500000,
    \"project_type_ids\": [
        1,
        2
    ],
    \"property_type_ids\": [
        1,
        5,
        6,
        7,
        8,
        9,
        10
    ],
    \"configurations\": [
        4,
        5,
        6,
        7
    ],
    \"area_min\": 100,
    \"area_max\": 2000,
    \"construction_statuses\": [
        1,
        2
    ],
    \"amenities\": [
        29,
        31,
        32,
        46,
        47,
        48,
        49,
        50,
        54,
        56
    ],
    \"no_of_bathrooms\": [
        2,
        3,
        4
    ],
    \"limit\": 10,
    \"offset\": 1,
    \"sort_key\": \"updated_at\",
    \"sort_order\": \"DESC\",
    \"top_property\": true,
    \"fast_selling\": true,
    \"blox_assured\": true,
    \"blox_exclusive\": true,
    \"is_trending\": true,
    \"is_featured\": true,
    \"is_popular\": true,
    \"is_verified\": true,
    \"is_gated_community\": true
}"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/property_search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "segments": "\/filters\/mumbai\/builders-developers?developer=9%2C32%2C33",
    "city_id": 256,
    "location_ids": [
        3,
        1
    ],
    "developer_ids": [
        4,
        3,
        8,
        12,
        19
    ],
    "budget_min": 5000000,
    "budget_max": 25500000,
    "project_type_ids": [
        1,
        2
    ],
    "property_type_ids": [
        1,
        5,
        6,
        7,
        8,
        9,
        10
    ],
    "configurations": [
        4,
        5,
        6,
        7
    ],
    "area_min": 100,
    "area_max": 2000,
    "construction_statuses": [
        1,
        2
    ],
    "amenities": [
        29,
        31,
        32,
        46,
        47,
        48,
        49,
        50,
        54,
        56
    ],
    "no_of_bathrooms": [
        2,
        3,
        4
    ],
    "limit": 10,
    "offset": 1,
    "sort_key": "updated_at",
    "sort_order": "DESC",
    "top_property": true,
    "fast_selling": true,
    "blox_assured": true,
    "blox_exclusive": true,
    "is_trending": true,
    "is_featured": true,
    "is_popular": true,
    "is_verified": true,
    "is_gated_community": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Property - Details

requires authentication

Used to get details of a specific Project

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/property/v1/property_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": \"7\",
    \"slug\": \"\",
    \"user_id\": \"\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/property/v1/property_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": "7",
    "slug": "",
    "user_id": ""
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/property_details

Body Parameters

Either Project Slug or Project ID should be selected

project_id  string  

slug  string  

Enter User ID to get is_favourite flag

user_id  integer optional  


requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/auth/v1/footer_seo_links" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"city_id\": \"256\",
    \"homepage\": false,
    \"project_type_ids\": [
        1,
        2
    ],
    \"property_type_ids\": [
        1,
        5,
        6,
        7,
        8,
        9,
        10
    ],
    \"developer_ids\": [
        1,
        2
    ],
    \"configurations\": [
        1,
        2
    ],
    \"construction_status\": [
        1,
        2
    ]
}"
const url = new URL(
    "https://api.qa.blox.co.in/auth/v1/footer_seo_links"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "city_id": "256",
    "homepage": false,
    "project_type_ids": [
        1,
        2
    ],
    "property_type_ids": [
        1,
        5,
        6,
        7,
        8,
        9,
        10
    ],
    "developer_ids": [
        1,
        2
    ],
    "configurations": [
        1,
        2
    ],
    "construction_status": [
        1,
        2
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Project - Get FAQ

Example request:
curl --request POST \
                "https://api.qa.blox.co.in/auth/v1/faq" \
                --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
                --header "Content-Type: application/json" \
                --header "Accept: application/json" \
                --data "{
                \"project_id\": \"62\"
            }"
            
const url = new URL(
                "https://api.qa.blox.co.in/auth/v1/faq"
            );
            
            const headers = {
                "Authorization": "Bearer {YOUR_AUTH_KEY}",
                "Content-Type": "application/json",
                "Accept": "application/json",
            };
            
            let body = {
                "project_id": "62"
            };
            
            fetch(url, {
                method: "POST",
                headers,
                body: JSON.stringify(body),
            }).then(response => response.json());

Request      

POST v1/faq

Body Parameters

project_id  required  

number

Order API Endpoints

Customer - Offline Payment

requires authentication

make offline payment

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/order/v1/make-payment-offline" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "ctoken=76e18e2f51bb738291b7dc945d92e7f7" \
    --form "order_type=Book" \
    --form "token_id=38|122|54|30631|142" \
    --form "ch_account_holder=Usain" \
    --form "ch_amount=1000" \
    --form "ch_account_type=Saving" \
    --form "ch_bank_name=SBI" \
    --form "ch_branch_name=Paschim Vihar" \
    --form "ch_no=867876" \
    --form "ch_date=05/08/2022" \
    --form "ch_file=@/tmp/phpYwS06s" 
const url = new URL(
    "https://api.qa.blox.co.in/order/v1/make-payment-offline"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', '76e18e2f51bb738291b7dc945d92e7f7');
body.append('order_type', 'Book');
body.append('token_id', '38|122|54|30631|142');
body.append('ch_account_holder', 'Usain');
body.append('ch_amount', '1000');
body.append('ch_account_type', 'Saving');
body.append('ch_bank_name', 'SBI');
body.append('ch_branch_name', 'Paschim Vihar');
body.append('ch_no', '867876');
body.append('ch_date', '05/08/2022');
body.append('ch_file', document.querySelector('input[name="ch_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST v1/make-payment-offline

Body Parameters

ctoken  string optional  

Customer token

order_type  string  

Order type Of Property['Book', 'EOI']

token_id  string  

Token Id Of property

ch_account_holder  string  

Account Holder

ch_amount  integer  

Amount

ch_account_type  string  

Type Of Account['Saving', 'Current']

ch_bank_name  string  

Bank Name

ch_branch_name  string  

Branch Name

ch_no  number  

Cheque No

ch_date  string  

Cheque Date

ch_file  file  

Cheque Image[format : 'png', 'jpeg', 'jpg', 'pdf'] Example:

channel_partner_id  integer optional  

Broker Id

Customer - Eoi Buyer details

requires authentication

Getting Eoi buyer details

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/order/v1/eoi-buyer-details?ctoken=76e18e2f51bb738291b7dc945d92e7f7&project_id=39&property_tower_id=147" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"numquam\",
    \"project_id\": 4,
    \"property_tower_id\": 4
}"
const url = new URL(
    "https://api.qa.blox.co.in/order/v1/eoi-buyer-details"
);

const params = {
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7",
    "project_id": "39",
    "property_tower_id": "147",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "numquam",
    "project_id": 4,
    "property_tower_id": 4
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v1/eoi-buyer-details

Query Parameters

ctoken  string optional  

Customer token

project_id  integer  

Project Id

property_tower_id  integer  

Id Of Project Tower Property

Customer Booking - update EOI customer details/with lead

requires authentication

update EOI customer details/with lead

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/order/v1/update-customer-details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Sachin Kumar\",
    \"email\": \"sachin.kumar@blox.xyz\",
    \"phone\": 9599174773,
    \"pincode\": 110001,
    \"user_type\": \"customer\",
    \"phone_country\": 91,
    \"project_id\": 39,
    \"property_tower_id\": 148,
    \"application_source\": 86
}"
const url = new URL(
    "https://api.qa.blox.co.in/order/v1/update-customer-details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Sachin Kumar",
    "email": "sachin.kumar@blox.xyz",
    "phone": 9599174773,
    "pincode": 110001,
    "user_type": "customer",
    "phone_country": 91,
    "project_id": 39,
    "property_tower_id": 148,
    "application_source": 86
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/update-customer-details

Body Parameters

name  string  

Name of Customer

email  string  

Email Id of Customer

phone  number  

Mobile of Customer

pincode  number  

Pincode of Customer

user_type  string  

Usertype of Customer

phone_country  number  

Pincode of Customer

project_id  integer  

Project Id

property_tower_id  integer  

Id Of Project Tower Property

application_source  number optional  

Application Source

Order - Generate RazorPay Order

requires authentication

gnerate razorPay order

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/order/v1/generate-order" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pay_type\": \"card\",
    \"order_type\": \"Book\",
    \"token_id\": \"38|122|54|30631|142\",
    \"ctoken\": \"76e18e2f51bb738291b7dc945d92e7f7\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/order/v1/generate-order"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "pay_type": "card",
    "order_type": "Book",
    "token_id": "38|122|54|30631|142",
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/generate-order

Body Parameters

pay_type  string  

Pay Type['card', 'upi', 'netbanking']

order_type  string  

Order Type['Book', 'EOI']

token_id  string  

Token Id Of property

ctoken  string optional  

Customer token

order_id  string optional  

Order Id

channel_partner_id  integer optional  

Broker Id

Customer - Update online transaction

requires authentication

update razorPay transaction

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/order/v1/update-transaction" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payment_id\": \"pay_K171MDDEtpQ6NF\",
    \"order_id\": \"O33638220803024911\",
    \"ctoken\": \"76e18e2f51bb738291b7dc945d92e7f7\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/order/v1/update-transaction"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "payment_id": "pay_K171MDDEtpQ6NF",
    "order_id": "O33638220803024911",
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/update-transaction

Body Parameters

payment_id  string  

RazorPay Payment Id

order_id  string  

Order Id

ctoken  string optional  

Customer token

Order - Get Booked Details

requires authentication

Get the details of Payment made for a Property using Order ID

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/order/v1/get-booked-details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_id\": \"O33542220614040146\",
    \"ctoken\": \"76e18e2f51bb738291b7dc945d92e7f7\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/order/v1/get-booked-details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order_id": "O33542220614040146",
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/get-booked-details

Body Parameters

order_id  string  

Order Id

ctoken  string optional  

Customer token

RM API Endpoints

RM - Dialer Details

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/getDialerDetails" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"rm_id\": 123,
\"campaign\": 456
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/getDialerDetails"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"rm_id": 123,
"campaign": 456
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/getDialerDetails

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

rm_id   integer   

The RM ID. Example: 123

campaign   integer  optional  

The campaign ID. Example: 456

RM - Dialer List

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/getDialedList" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"rm_id\": 123,
\"limit\": 10,
\"offset\": 0
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/getDialedList"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"rm_id": 123,
"limit": 10,
"offset": 0
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/getDialedList

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

rm_id   integer   

The RM ID. Must be a positive integer. Example: 123

order_by   string[]  optional  

nullable Optional sorting parameters.

limit   integer  optional  

nullable The maximum number of results to return. Must be at least 1. Example: 10

offset   integer  optional  

nullable The starting point to return results from. Must be at least 0. Example: 0

RM - Update Dial Status

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/updateDialStatus" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"rm_id\": 123,
\"customer_id\": 456,
\"call_status_id\": 789,
\"call_time\": \"2025-02-24 14:30:00\",
\"call_duration_in_seconds\": 180
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/updateDialStatus"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"rm_id": 123,
"customer_id": 456,
"call_status_id": 789,
"call_time": "2025-02-24 14:30:00",
"call_duration_in_seconds": 180
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/updateDialStatus

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

rm_id   integer   

The RM ID. Must be a positive integer. Example: 123

customer_id   integer   

The customer ID. Must be a positive integer. Example: 456

call_status_id   integer   

The call status ID. Must be a positive integer. Example: 789

call_time   string  optional  

nullable The timestamp of the call. Must follow the format: Y-m-d H:i:s. Example: 2025-02-24 14:30:00

call_duration_in_seconds   integer  optional  

nullable The duration of the call in seconds. Must be between 0 and 36000 (10 hours). Example: 180

RM - Update Contacts Details

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/getContactDetails" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/getContactDetails"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Accept": "application/json",
};

fetch(url, {
method: "POST",
headers,
}).then(response => response.json());

Request      

POST rm-major-1/getContactDetails

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Body Parameters

contacts   string[]  optional  

nullable An array of contacts to update.

RM - Add Dialer Customer

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/addDialerCustomer" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"rm_id\": 123,
\"customer_name\": \"John Doe\",
\"country_code\": \"91\",
\"mobile\": \"9876543210\",
\"campaign\": 5
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/addDialerCustomer"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"rm_id": 123,
"customer_name": "John Doe",
"country_code": "91",
"mobile": "9876543210",
"campaign": 5
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/addDialerCustomer

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

rm_id   integer   

The RM ID. Must be a positive integer. Example: 123

customer_name   string  optional  

nullable The name of the customer. Must contain only letters and spaces and should not exceed 50 characters. Example: John Doe

country_code   string  optional  

nullable The country code. Must be "91" for India. Example: 91

mobile   string   

The mobile number of the customer. Should be a valid 10-digit mobile number starting with a number between 6-9. Example: 9876543210

campaign   integer  optional  

nullable The campaign ID. Should be a valid integer. Example: 5

RM - RM List

requires authentication

Used to get RM list

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rm_list" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"project_id\": 8
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rm_list"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"project_id": 8
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rm_list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

project_id   integer   

Enter project_id Example: 8

rm_name   string  optional  

Enter rm name

RM - Logout

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rm_logout" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rm_logout"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rm_logout

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: e7ff6070baaa30946ad195e7ea678e9e

RM - Stamp Duty

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/stamp_duty" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"user_id\": null,
\"user_type\": null,
\"lead_project_id\": null,
\"status\": null
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/stamp_duty"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"user_id": null,
"user_type": null,
"lead_project_id": null,
"status": null
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/stamp_duty

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

user_id   integer   

Enter user id

user_type   string   

Enter user type example(Backend, Customer)

lead_project_id   integer   

Enter lead project id

status   integer   

Enter status example(1=>Pending, 2=>Done)

details   string  optional  

Enter details

payment_date   date  optional  

Enter payment date

RM - Finance

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/finance" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"user_id\": null,
\"user_type\": null,
\"lead_project_id\": null,
\"is_finance\": null
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/finance"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"user_id": null,
"user_type": null,
"lead_project_id": null,
"is_finance": null
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/finance

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

user_id   integer   

Enter user id

user_type   string   

Enter user type example(Backend, Customer)

lead_project_id   integer   

Enter lead project id

is_finance   integer   

Enter status Example for Backend: [1=>Customer is interested in availing Finance, 2=>Finance is in Progress,3=>Customer availed Finance, 4=>Finance request cancelled ], Example for Customer: [1=>I am interested in availing Finance, 3=>Availed Finance, 4=>Finance request cancelled],

finance_details   string  optional  

Enter details

finance_date   date  optional  

Enter payment date

RM - Agreement

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/agreement" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--form "user_id="\
--form "user_type="\
--form "lead_project_id="\
--form "is_agreement="\
--form "agreement_doc=@/private/var/folders/r8/dtmynt_n5k5cx2jb4hx1_nwc0000gp/T/phpj2kph89ih6qb9IAJfZa" 
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/agreement"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};

const body = new FormData();
body.append('user_id', '');
body.append('user_type', '');
body.append('lead_project_id', '');
body.append('is_agreement', '');
body.append('agreement_doc', document.querySelector('input[name="agreement_doc"]').files[0]);

fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());

Request      

POST rm-major-1/agreement

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Body Parameters

user_id   integer   

Enter user id

user_type   string   

Enter user type example(Backend, Customer)

lead_project_id   integer   

Enter lead project id

is_agreement   integer   

status Example for Backend: [1=>Customer is interested in executing Agreement,2=>Customer Agreement in Process, 3=>Agreement Executed, 4=>Agreement request cancelled], Example for Customer: [1=>I am interested in executing Agreement, 3=>Agreement Executed, 4=>Agreement request cancelled]

agreement_details   string  optional  

Enter details

agreement_date   date  optional  

Enter agreement date

agreement_doc   file  optional  

agreement doc [format : 'jpg,jpeg,png,gif,doc,docx,txt,pdf'] Example: Example: /private/var/folders/r8/dtmynt_n5k5cx2jb4hx1_nwc0000gp/T/phpj2kph89ih6qb9IAJfZa

RM - Request Booking

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/request_booking" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"user_id\": null,
\"lead_project_id\": null,
\"is_booking\": null,
\"comment\": null
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/request_booking"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"user_id": null,
"lead_project_id": null,
"is_booking": null,
"comment": null
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/request_booking

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

user_id   integer   

Enter user id

lead_project_id   integer   

Enter lead project id

is_booking   integer   

Enter status example(1=>Customer has raised the request for booking)

comment   string   

Enter comment

RM - Request EOI

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/request_eoi" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"user_id\": null,
\"lead_project_id\": null,
\"is_eoi\": null,
\"comment\": null
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/request_eoi"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"user_id": null,
"lead_project_id": null,
"is_eoi": null,
"comment": null
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/request_eoi

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

user_id   integer   

Enter user id

lead_project_id   integer   

Enter lead project id

is_eoi   integer   

Enter status example(1=>Customer has raised the request for EOI)

comment   string   

Enter comment

RM - Customer Inprogress Project

requires authentication

Used to Get all customer Inprogress Project List

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/inprogress_projects" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"customer_id\": null,
\"enquiry_id\": 30118
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/inprogress_projects"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"customer_id": null,
"enquiry_id": 30118
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/inprogress_projects

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

customer_id   integer   

Enter customer id

enquiry_id   integer   

Enter enquiry_id Example: 30118

RM - Project Detail

requires authentication

Used to Get Project Detail List

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rmproject_details" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"enquiry_id\": null,
\"project_id\": 30118
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rmproject_details"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"enquiry_id": null,
"project_id": 30118
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rmproject_details

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

enquiry_id   integer   

Enter enquiry id

project_id   integer   

Enter project_id Example: 30118

RM - Search Customer

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/search_customer" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
\"search_id\": \"enim\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/search_customer"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
"search_id": "enim"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/search_customer

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: e7ff6070baaa30946ad195e7ea678e9e

search_id   string   

Search token Example: Example: enim

RM - Signin

requires authentication

Used to Signin

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rmsignin" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"mobile\": \"9801234567\",
\"country_code\": \"91\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rmsignin"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"mobile": "9801234567",
"country_code": "91"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rmsignin

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

mobile   string   

Mobile of the RM Example: 9801234567

country_code   numeric   

Country Code of the RM Example: 91

device   string  optional  

Enter the Device info (example:- {"deviceToken": "xxxxxxxxxxxxxxxxx","deviceId": "9BDD22D9-54B8-4BF8-B3AD-A20314D5C84E", "deviceInfo": "iPhone 12 mini (iOS 15.4.1)", "deviceType": "IOS"} )

RM - Verify-OTP

requires authentication

Used to Verify OTP

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rmverify_otp" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"otp\": \"1234\",
\"email\": \"john@example.com\",
\"mobile\": \"9087654321\",
\"country_code\": \"91\",
\"device_id\": \"a2gdf3hh3\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rmverify_otp"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"otp": "1234",
"email": "john@example.com",
"mobile": "9087654321",
"country_code": "91",
"device_id": "a2gdf3hh3"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rmverify_otp

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

otp   numeric   

OTP of the RM Example: 1234

email   string   

Email of the RM Example: john@example.com

mobile   numeric   

Mobile of the RM Example: 9087654321

country_code   numeric   

Country Code of the RM Example: 91

device_id   string  optional  

Device Id Example: a2gdf3hh3

RM - Customer All Enquiry List

requires authentication

Used to Getcustomer all enquiry List

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/all_enquiry" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"customer_id\": null,
\"tab_id\": 2
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/all_enquiry"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"customer_id": null,
"tab_id": 2
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/all_enquiry

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

customer_id   integer   

Enter customer id

tab_id   number  optional  

Enter tab_id for get the result (1=Open, 2=All, 3=Won and 4=Lost) Example: 2

RM - Send-OTP

requires authentication

Used to Send OTP

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rmsend_otp" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"email\": \"john@example.com\",
\"mobile\": \"9087654321\",
\"country_code\": \"91\",
\"whatsapp_flag\": \"0\",
\"device_id\": \"a2gdf3hh3\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rmsend_otp"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"email": "john@example.com",
"mobile": "9087654321",
"country_code": "91",
"whatsapp_flag": "0",
"device_id": "a2gdf3hh3"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rmsend_otp

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

email   string   

Email of the RM Example: john@example.com

mobile   numeric   

Mobile of the RM Example: 9087654321

country_code   numeric   

Country Code of the RM Example: 91

whatsapp_flag   numeric  optional  

Whatsapp Flag Example: 0

device_id   string  optional  

Device Id Example: a2gdf3hh3

RM - Verify Social Login Token

requires authentication

Used to Verify Social Login Token

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rmverify_social_login_token" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"social_type\": \"google\",
\"social_token\": \"sdafsdjfasdjhx53kshdkasdhfkashdfks\",
\"device\": null
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rmverify_social_login_token"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"social_type": "google",
"social_token": "sdafsdjfasdjhx53kshdkasdhfkashdfks",
"device": null
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rmverify_social_login_token

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

social_type   string   

Email of the RM Example: google

social_token   string   

Social Token of the RM Example: sdafsdjfasdjhx53kshdkasdhfkashdfks

device   string   

Enter the Device info (example:- {"deviceToken": "xxxxxxxxxxxxxxxxx","deviceId": "9BDD22D9-54B8-4BF8-B3AD-A20314D5C84E", "deviceInfo": "iPhone 12 mini (iOS 15.4.1)", "deviceType": "IOS"} )

RM - Home Loan Request

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/homeLoanRequest" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"rm_id\": 123,
\"customer_id\": 456,
\"monthly_income\": \"\\\"50000\\\"\",
\"product\": \"\\\"Personal Loan\\\"\",
\"city\": \"\\\"Mumbai\\\"\",
\"ip_address\": \"\\\"192.168.1.1\\\"\",
\"enquiry_no_id\": \"\\\"ENQ12345\\\"\",
\"project_id\": \"101\",
\"refresh_auth\": \"\\\"1\\\"\",
\"requested_amount\": \"\\\"100000\\\"\",
\"pincode\": \"\\\"400001\\\"\",
\"employment_type\": \"\\\"Salaried\\\"\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/homeLoanRequest"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"rm_id": 123,
"customer_id": 456,
"monthly_income": "\"50000\"",
"product": "\"Personal Loan\"",
"city": "\"Mumbai\"",
"ip_address": "\"192.168.1.1\"",
"enquiry_no_id": "\"ENQ12345\"",
"project_id": "101",
"refresh_auth": "\"1\"",
"requested_amount": "\"100000\"",
"pincode": "\"400001\"",
"employment_type": "\"Salaried\""
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/homeLoanRequest

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

rm_id   integer  optional  

Required RM ID. Must be an integer. Example: 123

customer_id   integer  optional  

Required customer ID. Must be an integer. Example: 456

monthly_income   string  optional  

Required monthly income. Must be a string with a maximum length of 10 characters. Must be numeric. Example: "50000"

product   string|null  optional  

Optional product type. Must be a string and one of the valid products from the predefined list. Example: "Personal Loan"

city   string  optional  

Required city name. Must be a string containing only letters and spaces, and a maximum of 25 characters. Example: "Mumbai"

ip_address   string|null  optional  

Optional IP address. Must be a valid IP address if provided. Example: "192.168.1.1"

enquiry_no_id   string|null  optional  

Optional enquiry number ID. Example: "ENQ12345"

project_id   integer|null  optional  

Optional project ID. Must be an integer if provided. Example: 101

refresh_auth   string|null  optional  

Optional refresh authorization. Must be either "0" or "1". Example: "1"

requested_amount   string  optional  

Required requested amount. Must be a string with a maximum length of 10 characters and numeric. Example: "100000"

pincode   string  optional  

Required pincode. Must be a 6-digit numeric string. Example: "400001"

employment_type   string  optional  

Required employment type. Must be a string from the predefined list of valid types. Example: "Salaried"

RM - Location for pincode.

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/locations_for_pincode" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"odio\",
\"pincode\": \"\\\"123456\\\".\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/locations_for_pincode"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "odio",
"pincode": "\"123456\"."
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/locations_for_pincode

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The token used for authentication. Example: odio

pincode   string   

The pincode, must be exactly 6 digits and start with a non-zero digit. Example: "123456".

RM - Enquiry History

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/enquiry-history" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\",
\"enquiry_id\": 123
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/enquiry-history"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23",
"enquiry_id": 123
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/enquiry-history

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

enquiry_id   integer   

The ID of the enquiry whose history is to be retrieved. Must be a positive integer. Example: 123

RM - Unassign Enquiry

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rm_unassign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\",
\"enquiry_id\": 123
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rm_unassign"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23",
"enquiry_id": 123
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rm_unassign

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

enquiry_id   integer   

The ID of the enquiry to be unassigned. Must be a positive integer. Example: 123

RM - Get RM Sourcing Managers

requires authentication

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/sourcing_managers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/sourcing_managers"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET rm-major-1/sourcing_managers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: e7ff6070baaa30946ad195e7ea678e9e

RM - Campaigns

requires authentication

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/campaigns" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"user_id\": 123
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/campaigns"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"user_id": 123
};

fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET rm-major-1/campaigns

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

user_id   integer   

The ID of the user for whom the campaigns are being fetched. Must be a valid user ID. Example: 123

RM - Khoj Search by Phone

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/search_khoj" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\",
\"phone\": \"9876543210\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/search_khoj"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23",
"phone": "9876543210"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/search_khoj

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

phone   string   

The phone number to search for. Must be a 10-digit number. Example: 9876543210

RM - LeadGen Statistics

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/lead_gen_statistics" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/lead_gen_statistics"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/lead_gen_statistics

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

source   string[]  optional  

nullable An optional filter to specify the sources for the lead generation statistics.

RM - Enquiries

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/enquiries" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\",
\"source\": [
\"lead_gen\",
\"digital\"
],
\"status\": \"\\\"new\\\"\",
\"sub_status\": \"\\\"unactioned\\\"\",
\"limit\": 10,
\"offset\": 0,
\"search\": \"\\\"John Doe\\\"\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/enquiries"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23",
"source": [
"lead_gen",
"digital"
],
"status": "\"new\"",
"sub_status": "\"unactioned\"",
"limit": 10,
"offset": 0,
"search": "\"John Doe\""
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/enquiries

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

source   string[]   

The sources from which the enquiries should be fetched.

status   string   

The status of the enquiries to be fetched. Example: "new"

sub_status   string  optional  

optional The sub-status of the enquiries to be fetched. Example: "unactioned"

limit   integer  optional  

nullable The number of enquiries to fetch per request. Minimum: 1. Example: 10

offset   integer  optional  

nullable The offset for pagination. Minimum: 0. Example: 0

search   string  optional  

nullable A search term to filter the enquiries. Example: "John Doe"

RM - Upload User Location

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/upload_location" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\",
\"lat\": \"\\\"12.9716\\\"\",
\"long\": \"\\\"77.5946\\\"\",
\"address\": \"\\\"Bangalore, India\\\"\",
\"event_timestamp\": 1632499200
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/upload_location"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23",
"lat": "\"12.9716\"",
"long": "\"77.5946\"",
"address": "\"Bangalore, India\"",
"event_timestamp": 1632499200
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/upload_location

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

lat   string   

The latitude of the event location. Example: "12.9716"

long   string   

The longitude of the event location. Example: "77.5946"

address   string   

The address where the event took place. Example: "Bangalore, India"

event_timestamp   integer   

The timestamp of the event in Unix format. Example: 1632499200

RM - Get Location

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/get_location" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\",
\"from\": 1632499200,
\"to\": 1632585600
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/get_location"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23",
"from": 1632499200,
"to": 1632585600
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/get_location

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

from   integer   

The starting timestamp for the filter in Unix format. Example: 1632499200

to   integer   

The ending timestamp for the filter in Unix format. Example: 1632585600

members   string[]  optional  

nullable A list of members to filter the events.

zones   string[]  optional  

nullable A list of zones to filter the events.

RM - File Upload

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/upload_image" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--form "ctoken=a377dd62a692330c7066155684afcd23"\
--form "file=@/private/var/folders/r8/dtmynt_n5k5cx2jb4hx1_nwc0000gp/T/phpjnboaum6tljld0zHbyL" 
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/upload_image"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'a377dd62a692330c7066155684afcd23');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());

Request      

POST rm-major-1/upload_image

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

file   file   

The file to be uploaded. It should be in a valid file format. Example: /private/var/folders/r8/dtmynt_n5k5cx2jb4hx1_nwc0000gp/T/phpjnboaum6tljld0zHbyL

RM - BPCL

requires authentication

This endpoint returns a list of property types with corresponding unique integer identifiers. The response contains common property types such as "1 BHK", "2 BHK", and others, as well as commercial spaces like "Coworking Space" and "Restaurant".

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/bpcl" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/bpcl"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Accept": "application/json",
};

fetch(url, {
method: "GET",
headers,
}).then(response => response.json());

Request      

GET rm-major-1/bpcl

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

RM - ZoneLocationMapping

requires authentication

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/zone_location_mapping" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/zone_location_mapping"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23"
};

fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET rm-major-1/zone_location_mapping

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

RM - Notifications

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/notifications" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"a377dd62a692330c7066155684afcd23\",
\"type\": \"\'all\'\",
\"title\": \"\'New Update\'\",
\"body\": \"\'Important update for all members.\'\",
\"image\": \"\'https:\\/\\/example.com\\/image.jpg\'\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/notifications"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "a377dd62a692330c7066155684afcd23",
"type": "'all'",
"title": "'New Update'",
"body": "'Important update for all members.'",
"image": "'https:\/\/example.com\/image.jpg'"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/notifications

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The ctoken used for authentication. Example: a377dd62a692330c7066155684afcd23

type   string   

The type of notification. Can be either 'all' or 'specific_members'. Example: 'all'

title   string   

The title of the notification. Example: 'New Update'

body   string   

The body content of the notification. Example: 'Important update for all members.'

image   string  optional  

nullable An optional image URL related to the notification. Example: 'https://example.com/image.jpg'

members   string[]  optional  

nullable A list of specific members to notify (if type is 'specific_members').

RM - My Meeting

requires authentication

Used to Get My Meeting Data

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/my_meeting" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"tab_id\": 1,
\"limit\": 100,
\"offset\": 0
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/my_meeting"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"tab_id": 1,
"limit": 100,
"offset": 0
};

fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET rm-major-1/my_meeting

POST rm-major-1/my_meeting

PUT rm-major-1/my_meeting

PATCH rm-major-1/my_meeting

DELETE rm-major-1/my_meeting

OPTIONS rm-major-1/my_meeting

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

tab_id   number  optional  

Enter tab_id for get the result 1=today, 2=Tomorrow, 3=This Week, 4=All and 5=Pending Example: 1

limit   number  optional  

Example: 100

offset   number  optional  

Example: 0

RM -Accept Enquiry

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/accept_enquiry" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"enquiry_id\": null,
\"project_id\": null
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/accept_enquiry"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"enquiry_id": null,
"project_id": null
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/accept_enquiry

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

enquiry_id   integer   

Enter enquiry id

project_id   integer   

Enter project id

RM - Add RM Profile Pic

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/update_profile_pic" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--form "ctoken=e7ff6070baaa30946ad195e7ea678e9e"\
--form "profile_pic=@/private/var/folders/r8/dtmynt_n5k5cx2jb4hx1_nwc0000gp/T/php53j7tf5trr9fc33708X" 
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/update_profile_pic"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'e7ff6070baaa30946ad195e7ea678e9e');
body.append('profile_pic', document.querySelector('input[name="profile_pic"]').files[0]);

fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());

Request      

POST rm-major-1/update_profile_pic

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Body Parameters

ctoken   string   

Customer token Example: e7ff6070baaa30946ad195e7ea678e9e

profile_pic   file   

profile pic[format : 'png', 'jpeg', 'jpg'] Example: Example: /private/var/folders/r8/dtmynt_n5k5cx2jb4hx1_nwc0000gp/T/php53j7tf5trr9fc33708X

RM - Remove RM Profile Pic

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/remove_profile_pic" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/remove_profile_pic"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/remove_profile_pic

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: e7ff6070baaa30946ad195e7ea678e9e

RM - All Property List

requires authentication

Used to Get all Property List

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/rmmy_project" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"limit\": 100,
\"offset\": 0
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rmmy_project"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"limit": 100,
"offset": 0
};

fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET rm-major-1/rmmy_project

POST rm-major-1/rmmy_project

PUT rm-major-1/rmmy_project

PATCH rm-major-1/rmmy_project

DELETE rm-major-1/rmmy_project

OPTIONS rm-major-1/rmmy_project

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

enquiry_id   integer  optional  

optional Enter enquiry id

is_fromshortlited   integer  optional  

optional Enter is_fromshortlited

limit   number  optional  

Example: 100

offset   number  optional  

Example: 0

RM - Schedule Visit

requires authentication

Used to Schedule Visit

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/schedule_visit" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"enquiry_id\": 201,
\"project_id\": 23,
\"property_id\": 134,
\"visit_type\": 1,
\"next_schedule\": \"2022-09-22 02:00:00\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/schedule_visit"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"enquiry_id": 201,
"project_id": 23,
"property_id": 134,
"visit_type": 1,
"next_schedule": "2022-09-22 02:00:00"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/schedule_visit

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

enquiry_id   integer   

Enter enquiry_id Example: 201

project_id   integer   

Enter project_id Example: 23

property_id   integer   

Enter property_id Example: 134

visit_type   integer   

Enter visit_type (1=physical, 2=Virtual, 3=Telemeeting) Example: 1

next_schedule   date   

Enter datetime for next schedule (Y-m-d H:i:s') Example: 2022-09-22 02:00:00

RM - Interaction List

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/interaction_list" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"12345abcd\",
\"customer_id\": 1001,
\"enquiry_id\": \"2001\",
\"limit\": \"10\",
\"offset\": \"0\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/interaction_list"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "12345abcd",
"customer_id": 1001,
"enquiry_id": "2001",
"limit": "10",
"offset": "0"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/interaction_list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string  optional  

Required authentication token. Example: 12345abcd

customer_id   integer  optional  

Required customer ID. Must be an integer greater than or equal to 1. Example: 1001

enquiry_id   integer|null  optional  

Optional enquiry ID. Must be an integer greater than or equal to 1. Example: 2001

limit   integer|null  optional  

Optional limit for the number of results. Must be an integer greater than or equal to 1. Example: 10

offset   integer|null  optional  

Optional offset for pagination. Must be an integer greater than or equal to 0. Example: 0

RM - Add/Update Enquiry

requires authentication

Used to Add/Update Enquiry

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/add_update_enquiry" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"customer_id\": 33681,
\"enquiry_type\": 4,
\"master_source\": 25,
\"lead_source\": 26
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/add_update_enquiry"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"customer_id": 33681,
"enquiry_type": 4,
"master_source": 25,
"lead_source": 26
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/add_update_enquiry

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Enter RM token Example: 533b048254293d413630705cea308e1f

customer_id   integer   

Enter customer_id Example: 33681

enquiry_id   integer  optional  

Enter enquiry_id (This field is used to update the particular Enquiry.)

lead_id   integer  optional  

Enter lead_id (This field is used to update the particular Enquiry.)

enquiry_type   integer   

Enter enquiry type Example: 4

master_source   integer   

Enter master source Example: 25

lead_source   integer   

Enter lead source Example: 26

lead_sub_source   integer  optional  

Enter lead sub source

sub_source_details   integer  optional  

Enter sub source details

project_type   integer  optional  

Enter project type

project_subtype   integer  optional  

Enter project sub-type

city_id   integer  optional  

Enter city_id

location_id   integer  optional  

Enter location Id

budget_min   number  optional  

Enter Budget Min

budget_max   number  optional  

Enter Budget Max

purchase_timeframe   integer  optional  

Enter Purchase Timeframe

possession_timeline   integer  optional  

Enter Possession Timeline

buying_purpose   integer  optional  

Enter Buying Purpose

source_of_finance   integer  optional  

Enter Source of Finance

configuration   string  optional  

Enter Configuration (1 BHK, 1 RK, 1.5 BHK etc)

area_sqft   number  optional  

Enter Area Sqft (1200, 950, 2000 etc)

referrer_name   string  optional  

Enter Referrer Name

customer_life_time_value   number  optional  

Enter Customer Life Time Value

monthly_recurring_value   number  optional  

Enter Monthly Recurring Value

customer_referral_value   number  optional  

Enter Customer Referral Value

pincode_r   number  optional  

Enter Pincode (R)

suburb_r   number  optional  

Enter Suburb (R)

pincode_o   number  optional  

Enter Pincode (O)

suburb_o   number  optional  

Enter Suburb (O)

age   number  optional  

Enter Customer Age

gender   integer  optional  

Enter Customer Gender (1=Male | 2= Female)

marital_status   integer  optional  

Enter Customer's marital status (1=Married | 2= Unmarried)

industry   integer  optional  

Enter Industry

organization   string  optional  

Enter organization name

occupation   integer  optional  

Enter occupation Id

designation   integer  optional  

Enter Designation Id

household_income   number  optional  

Enter Household Income

highest_education   integer  optional  

Enter Highest Education Id

family_size   integer  optional  

Enter Family Size Id

current_residence   string  optional  

Enter Current Residence

ethnicity   integer  optional  

Enter Ethnicity Id

birthday_date   date  optional  

Enter Birthday Date (Format: Y-m-d)

spouse_birthday_date   date  optional  

Enter Spouse Birthday Date (Format: Y-m-d)

anniversary_date   date  optional  

Enter Anniversary Date (Format: Y-m-d)

RM - Add Project for enquiry.

requires authentication

Used to add project for enquiry.

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/add_project" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"customer_id\": 35073,
\"enquiry_id\": 30143,
\"project_id\": 1
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/add_project"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"customer_id": 35073,
"enquiry_id": 30143,
"project_id": 1
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/add_project

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

customer_id   integer   

Enter customer_id Example: 35073

enquiry_id   integer   

Enter enquiry_id Example: 30143

project_id   integer   

Enter project_id Example: 1

lead_id   integer  optional  

Enter lead_id

lead_projects_id   integer  optional  

Enter lead_projects_id

RM - Assign RM

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/assign_rm" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
\"enquiry_id\": \"error\",
\"rm_id\": 8,
\"is_fromshortlited\": null
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/assign_rm"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
"enquiry_id": "error",
"rm_id": 8,
"is_fromshortlited": null
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/assign_rm

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: e7ff6070baaa30946ad195e7ea678e9e

enquiry_id   string   

Enquiry Id Example: Example: error

rm_id   integer   

RM Id Example: Example: 8

is_fromshortlited   integer   

RM Id

RM - Project List RM

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/project_list" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
\"enquiry_id\": 30143
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/project_list"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
"enquiry_id": 30143
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/project_list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: e7ff6070baaa30946ad195e7ea678e9e

enquiry_id   integer   

Enter enquiry_id Example: 30143

RM - Get Particular Enquiry Detail.

requires authentication

Used to Get Enquiry details for update-case.

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/get_enquiry?ctoken=533b048254293d413630705cea308e1f" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/get_enquiry"
);

const params = {
"ctoken": "533b048254293d413630705cea308e1f",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Accept": "application/json",
};

fetch(url, {
method: "GET",
headers,
}).then(response => response.json());

Request      

GET rm-major-1/get_enquiry

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Query Parameters

ctoken   string   

RM token Example: 533b048254293d413630705cea308e1f

enquiry_id   integer  optional  

Enter enquiry_id to get interaction related to a particular enquiry.

RM - get Pipeline enquiry

requires authentication

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/get_enquiry_details" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"culpa\",
\"enquiry_id\": 123
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/get_enquiry_details"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "culpa",
"enquiry_id": 123
};

fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET rm-major-1/get_enquiry_details

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The token used for authentication. Example: culpa

enquiry_id   integer   

The ID of the enquiry, must be a positive integer. Example: 123

RM - Dashboard

requires authentication

Used to Get Dashboard Data

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/my_dashboard" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"tab_id\": 1,
\"limit\": 100,
\"offset\": 0
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/my_dashboard"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"tab_id": 1,
"limit": 100,
"offset": 0
};

fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET rm-major-1/my_dashboard

POST rm-major-1/my_dashboard

PUT rm-major-1/my_dashboard

PATCH rm-major-1/my_dashboard

DELETE rm-major-1/my_dashboard

OPTIONS rm-major-1/my_dashboard

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

tab_id   number  optional  

Enter tab_id for get the result (1=today, 2=Tomorrow, 3=This Week and 4=All) Example: 1

limit   number  optional  

Example: 100

offset   number  optional  

Example: 0

RM - Get RM Profile

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/get_profile" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/get_profile"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/get_profile

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: e7ff6070baaa30946ad195e7ea678e9e

RM - My Portfolio List

requires authentication

Used to Get My Portfolio List

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/rm_my_portfolio" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"limit\": 100,
\"offset\": 0
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/rm_my_portfolio"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"limit": 100,
"offset": 0
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/rm_my_portfolio

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

master_source_id   integer  optional  

Enter master source id

search_by   string  optional  

Enter search by (enquiry_date=>Enquiry Date,call_back=>Last Interaction Date)

from   date  optional  

Enter from date(Y-m-d H:i)

to   date  optional  

Enter to date(Y-m-d H:i)

limit   number  optional  

Example: 100

offset   number  optional  

Example: 0

RM - Shortlisted Project List.

requires authentication

Used to Get shortlisted project list.

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/shortlisted_projects_list" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"customer_id\": 35073,
\"limit\": 100,
\"offset\": 0
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/shortlisted_projects_list"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"customer_id": 35073,
"limit": 100,
"offset": 0
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/shortlisted_projects_list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

RM token Example: 533b048254293d413630705cea308e1f

customer_id   integer   

Enter customer_id Example: 35073

limit   number  optional  

Example: 100

offset   number  optional  

Example: 0

RM -All Filter Master Data List

requires authentication

Used to Get All Filter Master Data List

Example request:
curl --request GET \
--get "https://api.qa.blox.co.in/rm/rm-major-1/allfiter_masterdata" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
\"limit\": 100,
\"offset\": 0
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/allfiter_masterdata"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
"limit": 100,
"offset": 0
};

fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET rm-major-1/allfiter_masterdata

POST rm-major-1/allfiter_masterdata

PUT rm-major-1/allfiter_masterdata

PATCH rm-major-1/allfiter_masterdata

DELETE rm-major-1/allfiter_masterdata

OPTIONS rm-major-1/allfiter_masterdata

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

RM token Example: e7ff6070baaa30946ad195e7ea678e9e

limit   number  optional  

Limit Example: 100

offset   number  optional  

Offest Example: 0

RM - Add Interaction

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/save_interaction" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"enquiry_id\": null,
\"lead_status\": null,
\"comment\": null,
\"next_follow_date\": null
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/save_interaction"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"enquiry_id": null,
"lead_status": null,
"comment": null,
"next_follow_date": null
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/save_interaction

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

enquiry_id   integer   

Enter enquiry id

lead_status   integer   

Enter lead Status

lead_sub_status   integer  optional  

Enter lead sub-status

project_id   integer  optional  

Enter project id

comment   string   

Enter comment

next_follow_date   date   

Enter callback date

rating   integer  optional  

Enter rating qual

visit_date   date  optional  

Enter visit date

lead_sub_status_reason   integer  optional  

Enter visit date

lead_qual_status   integer  optional  

Enter lead qual status

call_status   integer  optional  

Enter call status

RM - My Task List

requires authentication

Used to Get My Task

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/my_task_list" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"533b048254293d413630705cea308e1f\",
\"day\": \"today\",
\"limit\": 100,
\"offset\": 0
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/my_task_list"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "533b048254293d413630705cea308e1f",
"day": "today",
"limit": 100,
"offset": 0
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/my_task_list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

Customer token Example: 533b048254293d413630705cea308e1f

day   string  optional  

Enter day for get the result (Today=today, Tomorrow=tomorrow, Till Yesterday=till_yesterday and All=all) Example: today

type   integer  optional  

Enter enquiry type

lead_status   number  optional  

Enter Lead-status

lead_sub_status   number  optional  

ENter lead sub-status

status   number  optional  

Enter status

project_id   number  optional  

Enter project Id

project_name   string  optional  

Enter project name

name   string  optional  

enter customer name

email   string  optional  

Enter customer's email address

mobile   number  optional  

Enter customer mobile no

from   date  optional  

Enter Callback From Date

to   date  optional  

Enter Callback To Date

limit   number  optional  

Example: 100

offset   number  optional  

Example: 0

RM - My Team Task List.

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/myteam_task_list" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"12345abcd\",
\"limit\": \"10\",
\"offset\": \"20\",
\"start_date\": \"2025-02-01\",
\"end_date\": \"2025-02-28\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/myteam_task_list"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "12345abcd",
"limit": "10",
"offset": "20",
"start_date": "2025-02-01",
"end_date": "2025-02-28"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/myteam_task_list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string|null  optional  

Optional token for authentication. Example: 12345abcd

limit   integer|null  optional  

Optional limit for the number of results. Must be an integer greater than or equal to 1. Example: 10

offset   integer|null  optional  

Optional offset for pagination. Must be an integer greater than or equal to 0. Example: 20

start_date   string  optional  

Required start date in "Y-m-d" format. Must be a valid date. Example: 2025-02-01

end_date   string  optional  

Required end date in "Y-m-d" format. Must be a valid date and after or equal to the start date. Example: 2025-02-28

RM - My team statistics

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/my_team_statistics" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"\\\"abc123xyz\\\"\",
\"from\": \"\\\"2025-02-01\\\"\",
\"to\": \"\\\"2025-02-25\\\"\",
\"zone_ids\": \"[1, 2, 3]\",
\"team_members\": \"[101, 102, 103]\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/my_team_statistics"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "\"abc123xyz\"",
"from": "\"2025-02-01\"",
"to": "\"2025-02-25\"",
"zone_ids": "[1, 2, 3]",
"team_members": "[101, 102, 103]"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/my_team_statistics

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string  optional  

Required token for authentication. Example: "abc123xyz"

from   string  optional  

Required start date. Must be a valid date and before or equal to the current date. Example: "2025-02-01"

to   string  optional  

Required end date. Must be a valid date, after or equal to the "from" date, and before or equal to the current date. Example: "2025-02-25"

zone_ids   array|null  optional  

Optional list of zone IDs. Example: [1, 2, 3]

team_members   array|null  optional  

Optional list of team members. Example: [101, 102, 103]

RM - My Team List.

requires authentication

Example request:
curl --request POST \
"https://api.qa.blox.co.in/rm/rm-major-1/my_team_list" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--data "{
\"ctoken\": \"veniam\",
\"zones\": \"repudiandae\",
\"sort\": \"tempora\"
}"
const url = new URL(
"https://api.qa.blox.co.in/rm/rm-major-1/my_team_list"
);

const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};

let body = {
"ctoken": "veniam",
"zones": "repudiandae",
"sort": "tempora"
};

fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rm-major-1/my_team_list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Body Parameters

ctoken   string   

The token used for authentication. Example: veniam

zones   array|null  optional  

List of zones. Optional parameter. Example: repudiandae

sort   array|null  optional  

Sorting options. Optional parameter. Example: tempora

Developer API Endpoints

Developer - Developer List

requires authentication

Used to get developer list

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v1/developer_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v1/developer_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/developer_list

Body Parameters

top_developer  number optional  

top_developer Select 1 for top developers, 0 for non top developers, if value not provided it will send both non and top developers

limit  number optional  

offset  number optional  

Developers

requires authentication

Used to get developers

Example request:
curl --request POST \
            "https://api.qa.blox.co.in/developer/v1/developers" \
            --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --data "{
            \"top_developer\": 0,
            \"sort_key\": \"alphabet\",
            \"city_id\": 269,
            \"sort_order\": \"ASC\",
            \"limit\": 100,
            \"offset\": 0
        }"
        
const url = new URL(
            "https://api.qa.blox.co.in/developer/v1/developers"
        );

        const headers = {
            "Authorization": "Bearer {YOUR_AUTH_KEY}",
            "Content-Type": "application/json",
            "Accept": "application/json",
        };

        let body = {
            "top_developer": 0,
            "sort_key": "alphabet",
            "city_id": 269,
            "sort_order": "ASC",
            "limit": 100,
            "offset": 0
        };

        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

Request      

POST v1/developers

Body Parameters

top_developer   optional  

Select 1 for top developers, 0 for non top developers, if value not provided it will send both non and top developers

keyword  select optional  

Keyword to be searched in developers name Example: Birla Estates

city_id  number  

city_id for top developer Example: 269

sort_key  select optional  

latest,alphabet,year for fetching developers

sort_order  select optional  

ASC or DESC for fetching developers

limit  number optional  

offset  number optional  

Developer - Get Developer Details

requires authentication

Used to Get Developer Details

Example request:
curl --request POST \
            "https://api.qa.blox.co.in/developer/v1/get_developer_details" \
            --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --data "{
            \"ctoken\": \"e3e3e48db7f4f01938fdd6791eaa8e6c\"
        }"
        
const url = new URL(
            "https://api.qa.blox.co.in/developer/v1/get_developer_details"
        );

        const headers = {
            "Authorization": "Bearer {YOUR_AUTH_KEY}",
            "Content-Type": "application/json",
            "Accept": "application/json",
        };

        let body = {
            "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c"
        };

        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

Request      

POST v1/get_developer_details

Body Parameters

ctoken  string  

Customer token

Developer - all projects list with enquiries

requires authentication

all projects list with enquiries

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/customer/v1/developer-projects?ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c&search_key=aws&limit=10&offset=0&date_from=2021-01-01&date_to=2023-01-01" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/customer/v1/developer-projects"
);

const params = {
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c",
    "search_key": "aws",
    "limit": "10",
    "offset": "0",
    "date_from": "2021-01-01",
    "date_to": "2023-01-01",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/developer-projects

Query Parameters

ctoken  string  

Customer token

search_key  string optional  

Search Key(by project name)

limit  number optional  

offset  number optional  

date_from  string optional  

Date From(Y-m-d)

date_to  string optional  

Date To(Y-m-d)

Developer - Monthwise enquiries count

requires authentication

Monthwise enquiries count

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v1/enquiries/count-by-month?ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c&project_id=0&date_from=2021-01-01&date_to=2023-01-01" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v1/enquiries/count-by-month"
);

const params = {
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c",
    "project_id": "0",
    "date_from": "2021-01-01",
    "date_to": "2023-01-01",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v1/enquiries/count-by-month

Query Parameters

ctoken  string  

Customer token

project_id  number  

Project Id(0 => All developer projects)

date_from  string  

Date From(Y-m-d)

date_to  string  

Date To(Y-m-d)

Developer - Profile update

requires authentication

update developer profile

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v1/update-profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c" \
    --form "name=piramal ananya" \
    --form "legal_entity_name=piramal ananya" \
    --form "cin=L70200MH10PTC123456" \
    --form "gst_no=12BLOXS1234A1BC" \
    --form "tan_no=BLOXS1234A" \
    --form "pan_no=BLOXS1234A" \
    --form "company_founded_in_year=2022" \
    --form "whatsapp_receive_updates=0" \
    --form "point_of_contact_no=9087654321" \
    --form "point_of_contact_email=tony@example.com" \
    --form "developer_id=37" \
    --form "image=@/tmp/phpxnvlTC" 
const url = new URL(
    "https://api.qa.blox.co.in/developer/v1/update-profile"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'e3e3e48db7f4f01938fdd6791eaa8e6c');
body.append('name', 'piramal ananya');
body.append('legal_entity_name', 'piramal ananya');
body.append('cin', 'L70200MH10PTC123456');
body.append('gst_no', '12BLOXS1234A1BC');
body.append('tan_no', 'BLOXS1234A');
body.append('pan_no', 'BLOXS1234A');
body.append('company_founded_in_year', '2022');
body.append('whatsapp_receive_updates', '0');
body.append('point_of_contact_no', '9087654321');
body.append('point_of_contact_email', 'tony@example.com');
body.append('developer_id', '37');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST v1/update-profile

Body Parameters

ctoken  string  

Customer token

name  string  

Name

legal_entity_name  string  

Legal Entity Name

cin  string  

CIN

gst_no  string  

GST No

tan_no  string  

Tan No

pan_no  string  

Pan No

company_founded_in_year  string optional  

Must be 4 digits.

image  file optional  

file Developer Logo[format : 'png', 'jpeg', 'jpg'] Example:

whatsapp_receive_updates  integer optional  

Whether to receive whatsapp updates[0,1].

point_of_contact_no  numeric  

Mobile of the Developer

point_of_contact_email  string  

Email of the Developer

registered_address  string optional  

Registered Address

corporate_address  string optional  

Corporate Address

developer_id  integer  

Developer Id

Developer - Recent Booked Propert By Developer

requires authentication

Recent Booked Propert By Developer

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v1/recent-booked-property" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_type\": \"developer\",
    \"limit_recent\": \"5\",
    \"ctoken\": \"e3e3e48db7f4f01938fdd6791eaa8e6c\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v1/recent-booked-property"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_type": "developer",
    "limit_recent": "5",
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/recent-booked-property

Body Parameters

user_type  string  

user_type

limit_recent  required optional  

limit_recent

ctoken  string optional  

Customer token

Developer - Developer Booked Property

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v1/developer-booked-property?ctoken=f4bbdc73b517a7e34ce00adaf7ba7491&limit=10&offset=0&client_id=0&project_id=0&client_name_sort=atoz&project_name_sort=atoz&agreement_min_price=100&agreement_max_price=1000000&agreement_sort=htol&date_from=100&date_to=21-09-2022&date_sort=25-09-2022&configuration=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": \"ea\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v1/developer-booked-property"
);

const params = {
    "ctoken": "f4bbdc73b517a7e34ce00adaf7ba7491",
    "limit": "10",
    "offset": "0",
    "client_id": "0",
    "project_id": "0",
    "client_name_sort": "atoz",
    "project_name_sort": "atoz",
    "agreement_min_price": "100",
    "agreement_max_price": "1000000",
    "agreement_sort": "htol",
    "date_from": "100",
    "date_to": "21-09-2022",
    "date_sort": "25-09-2022",
    "configuration": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "limit": "ea"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/developer-booked-property

Query Parameters

ctoken  string  

limit  number optional  

offset  number optional  

client_id  number optional  

project_id  number optional  

client_name_sort  string optional  

project_name_sort  string optional  

agreement_min_price  number optional  

agreement_max_price  number optional  

agreement_sort  string optional  

date_from  string optional  

date_to  string optional  

date_sort  string optional  

configuration  number optional  

Body Parameters

limit  string  

Developer - Client Name Api

requires authentication

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v1/Search-Client-name?ctoken=f4bbdc73b517a7e34ce00adaf7ba7491&client_name=arti" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_name\": \"et\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v1/Search-Client-name"
);

const params = {
    "ctoken": "f4bbdc73b517a7e34ce00adaf7ba7491",
    "client_name": "arti",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "client_name": "et"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v1/Search-Client-name

Query Parameters

ctoken  string  

client_name  string optional  

List of client name

Body Parameters

client_name  string  

Developer - Project Name Api

requires authentication

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v1/Search-project-name?ctoken=f4bbdc73b517a7e34ce00adaf7ba7491&project_name=arti" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_name\": \"sit\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v1/Search-project-name"
);

const params = {
    "ctoken": "f4bbdc73b517a7e34ce00adaf7ba7491",
    "project_name": "arti",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_name": "sit"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v1/Search-project-name

Query Parameters

ctoken  string  

project_name  string optional  

List of project name

Body Parameters

project_name  string  

Developer API V2 Endpoints

Developer - Developer List

requires authentication

Used to get developer list

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/developer_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"top_developer\": 213632829.80435,
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/developer_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "top_developer": 213632829.80435,
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/developer_list

Body Parameters

top_developer  number optional  

top_developer Select 1 for top developers, 0 for non top developers, if value not provided it will send both non and top developers Example:

limit  number optional  

offset  number optional  

Developer - Developers

requires authentication

Used to get developers

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/developers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"top_developer\": 1022241.748991,
    \"keyword\": \"Birla\",
    \"city_id\": 269,
    \"sort_key\": \"alphabet\",
    \"sort_order\": \"ASC\",
    \"limit\": 100,
    \"offset\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/developers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "top_developer": 1022241.748991,
    "keyword": "Birla",
    "city_id": 269,
    "sort_key": "alphabet",
    "sort_order": "ASC",
    "limit": 100,
    "offset": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/developers

Body Parameters

top_developer  number optional  

top_developer Select 1 for top developers, 0 for non top developers, if value not provided it will send both non and top developers Example:

keyword  string optional  

Keyword to be searched in developers name.

city_id  number  

city_id for top developer

sort_key  select optional  

latest,alphabet,year for fetching developers

sort_order  select optional  

ASC or DESC for fetching developers

limit  number optional  

offset  number optional  

Developer - Developer Escrow Details

requires authentication

Developer Escrow Details

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/developer-escrow-details?escrow_id=10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"escrow_id\": 460351805
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/developer-escrow-details"
);

const params = {
    "escrow_id": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "escrow_id": 460351805
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/developer-escrow-details

Query Parameters

escrow_id  number  

Body Parameters

escrow_id  integer  

Must be at least 0. Must not be greater than 2147483647.

Developer - Developer Escrow List

requires authentication

Developer Escrow List

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/developer-escrow?ctoken=e7ff6070baaa30946ad195e7ea678e9e&limit=10&offset=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": 82,
    \"offset\": 287752406
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/developer-escrow"
);

const params = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "limit": "10",
    "offset": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "limit": 82,
    "offset": 287752406
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/developer-escrow

Query Parameters

ctoken  string  

Developer token

limit  number  

Limit(minimum value 1, max value 1000)

offset  number  

Offset(minimum value 0, max value 2147483647)

Body Parameters

limit  integer  

Must be at least 1. Must not be greater than 1000.

offset  integer  

Must be at least 0. Must not be greater than 2147483647.

Developer - Recent Booked Propert By Developer

requires authentication

Recent Booked Propert By Developer

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/recent-booked-property" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_type\": \"developer\",
    \"limit_recent\": \"5\",
    \"ctoken\": \"e3e3e48db7f4f01938fdd6791eaa8e6c\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/recent-booked-property"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_type": "developer",
    "limit_recent": "5",
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/recent-booked-property

Body Parameters

user_type  string  

user_type

limit_recent  required optional  

limit_recent

ctoken  string optional  

Customer token

Developer - Get Developer Profile

requires authentication

Getting Developer Profile

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/get_profile_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"76e18e2f51bb738291b7dc945d92e7f7\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/get_profile_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "76e18e2f51bb738291b7dc945d92e7f7"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/get_profile_details

Body Parameters

ctoken  string  

Developer token

Developer - Update Profile Details

requires authentication

Used to Update Profile Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/update/user/details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"name\": \"john\",
    \"dob\": \"1991-01-01\",
    \"designation\": \"Developer\",
    \"email\": \"john@example.com\",
    \"mobile\": \"9087654321\",
    \"country_code\": \"91\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/update/user/details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "name": "john",
    "dob": "1991-01-01",
    "designation": "Developer",
    "email": "john@example.com",
    "mobile": "9087654321",
    "country_code": "91"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/update/user/details

Body Parameters

ctoken  string  

Customer token

name  string  

Name of the Customer

role_id  number optional  

Role Id

dob  string optional  

designation  string optional  

Designation(accepts alphabets, numeric and - characters with maximum length 100)

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code

address  string optional  

Enter Developer address(accepts alphabets, numeric and ,-_./ characters with maximum length 200)

city_id  integer optional  

Enter City id

state_id  integer optional  

Enter State id

pincode  string optional  

Enter pincode

Developer - Add Developer Profile Pic

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/update_profile_pic" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "ctoken=e7ff6070baaa30946ad195e7ea678e9e" \
    --form "profile_pic=@/tmp/phpe6pFR5" 
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/update_profile_pic"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'e7ff6070baaa30946ad195e7ea678e9e');
body.append('profile_pic', document.querySelector('input[name="profile_pic"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST v2/update_profile_pic

Body Parameters

ctoken  string  

Customer token

profile_pic  file  

profile pic[format : 'png', 'jpeg', 'jpg'] Example:

Developer - Remove Developer Profile Pic

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/remove_profile_pic" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/remove_profile_pic"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/remove_profile_pic

Body Parameters

ctoken  string  

Customer token

Developer - Developer Booked Property

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/developer-booked-property" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": 10,
    \"offset\": 0,
    \"orderType\": \"EOI\",
    \"agreement_max_price\": 1000000,
    \"agreement_min_price\": 100,
    \"configuration\": 1,
    \"ctoken\": \"4c98182b4e2685c26e234024db64a713\",
    \"date_from\": \"2022-06-09\",
    \"date_to\": \"2022-12-09\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/developer-booked-property"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "limit": 10,
    "offset": 0,
    "orderType": "EOI",
    "agreement_max_price": 1000000,
    "agreement_min_price": 100,
    "configuration": 1,
    "ctoken": "4c98182b4e2685c26e234024db64a713",
    "date_from": "2022-06-09",
    "date_to": "2022-12-09"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/developer-booked-property

Body Parameters

limit  number  

Limit(minimum value 1, max value 1000)

offset  number  

Offset(minimum value 0, max value 2147483647)

orderType  string  

Order Type(EOI, Book, cancelled)

agreement_max_price  number optional  

Agreement Max Price

agreement_min_price  number optional  

Agreement Min Price

date_sort  string optional  

Sort by Date[0,1]

client_name_sort  number optional  

Sort by client name(0,1)

project_name_sort  string optional  

Sort by project name(0,1)

agreement_sort  string optional  

Sort by Agreement price(0,1)

configuration  number optional  

Configurations(comma separated)

project_id  number optional  

Project Ids(comma separated)

client_id  number optional  

Customer Ids(comma separated)

ctoken  required optional  

Developer Token

date_from  string optional  

date_to  string optional  

payment_status  string optional  

Payment Status comma separated(success,cancelled,failed, pending)

Developer - Client Name Api

requires authentication

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/Search-Client-name?ctoken=f4bbdc73b517a7e34ce00adaf7ba7491&client_name=arti" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/Search-Client-name"
);

const params = {
    "ctoken": "f4bbdc73b517a7e34ce00adaf7ba7491",
    "client_name": "arti",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v2/Search-Client-name

Query Parameters

ctoken  string  

Developer Token

client_name  string optional  

Search by client name

Developer - Project Name Api

requires authentication

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/Search-project-name?ctoken=4c98182b4e2685c26e234024db64a713&project_name=arti" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/Search-project-name"
);

const params = {
    "ctoken": "4c98182b4e2685c26e234024db64a713",
    "project_name": "arti",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v2/Search-project-name

Query Parameters

ctoken  string  

Developer Token

project_name  string optional  

Search by project name

Developer - Get Developer Details

requires authentication

Used to Get Developer Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/get_developer_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/get_developer_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/get_developer_details

Body Parameters

ctoken  string  

Developer token

Developer - Profile update

requires authentication

update developer profile

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/update-profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c" \
    --form "name=piramal ananya" \
    --form "legal_entity_name=piramal ananya" \
    --form "cin=L70200MH10PTC123456" \
    --form "gst_no=12BLOXS1234A1BC" \
    --form "tan_no=BLOXS1234A" \
    --form "pan_no=BLOXS1234A" \
    --form "company_founded_in_year=6354" \
    --form "whatsapp_receive_updates=0" \
    --form "point_of_contact_no=9087654321" \
    --form "point_of_contact_email=tony@example.com" \
    --form "developer_id=37" \
    --form "image=@/tmp/phplKTBjw" 
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/update-profile"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'e3e3e48db7f4f01938fdd6791eaa8e6c');
body.append('name', 'piramal ananya');
body.append('legal_entity_name', 'piramal ananya');
body.append('cin', 'L70200MH10PTC123456');
body.append('gst_no', '12BLOXS1234A1BC');
body.append('tan_no', 'BLOXS1234A');
body.append('pan_no', 'BLOXS1234A');
body.append('company_founded_in_year', '6354');
body.append('whatsapp_receive_updates', '0');
body.append('point_of_contact_no', '9087654321');
body.append('point_of_contact_email', 'tony@example.com');
body.append('developer_id', '37');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST v2/update-profile

Body Parameters

ctoken  string optional  

Customer token

name  string  

Name

legal_entity_name  string  

Legal Entity Name

cin  string  

CIN

gst_no  string  

GST No

tan_no  string  

Tan No

pan_no  string  

Pan No

company_founded_in_year  string optional  

Must be 4 digits.

image  file optional  

file Developer Logo[format : 'png', 'jpeg', 'jpg'] Example:

whatsapp_receive_updates  integer optional  

Whether to receive whatsapp updates[0,1].

point_of_contact_no  numeric  

Mobile of the Developer

point_of_contact_email  string  

Email of the Developer

registered_address  string optional  

Registered Address

corporate_address  string optional  

Corporate Address

developer_id  integer optional  

Developer Id

Developer - all projects list with enquiries

requires authentication

all projects list with enquiries

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/developer-projects?ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c&search_key=aws&limit=10&offset=0&date_from=2021-01-01&date_to=2023-01-01" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/developer-projects"
);

const params = {
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c",
    "search_key": "aws",
    "limit": "10",
    "offset": "0",
    "date_from": "2021-01-01",
    "date_to": "2023-01-01",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v2/developer-projects

Query Parameters

ctoken  string  

Customer token

search_key  string optional  

Search Key(by project name)

limit  number optional  

offset  number optional  

date_from  string optional  

Date From(Y-m-d)

date_to  string optional  

Date To(Y-m-d)

Developer - Monthwise enquiries count

requires authentication

Monthwise enquiries count

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/enquiries/count-by-month?ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c&project_id=0&date_from=2021-01-01&date_to=2023-01-01&limit_recent=3&dashboard=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/enquiries/count-by-month"
);

const params = {
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c",
    "project_id": "0",
    "date_from": "2021-01-01",
    "date_to": "2023-01-01",
    "limit_recent": "3",
    "dashboard": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v2/enquiries/count-by-month

Query Parameters

ctoken  string  

Customer token

project_id  number optional  

Project Id(0 => All developer projects)

date_from  string optional  

Date From(Y-m-d)

date_to  string optional  

Date To(Y-m-d)

limit_recent  number  

limit_recent

dashboard  number optional  

dashoboard

Developer - Booking Overview

requires authentication

Booking Overview

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/bookings/overview?ctoken=72755da8ed85da9b938d44ed6f030ee3&date_from=2022-01-01&date_to=2022-06-01&state_id=0&city_id=0&project_id=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/bookings/overview"
);

const params = {
    "ctoken": "72755da8ed85da9b938d44ed6f030ee3",
    "date_from": "2022-01-01",
    "date_to": "2022-06-01",
    "state_id": "0",
    "city_id": "0",
    "project_id": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v2/bookings/overview

Query Parameters

ctoken  string  

Deeloper token

date_from  string  

Date From(Y-m-d)

date_to  string  

Date To(Y-m-d)

state_id  number  

state where projects belong [0 means all states]

city_id  number  

city of a state[0 means all cities of a state]

project_id  number optional  

Project Id[0 or blank means all projects]

Developer - Add Associated Project

requires authentication

Developer Add Associated Project

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/add_associated_project" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"project_id\": \"45,49\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/add_associated_project"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "project_id": "45,49"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/add_associated_project

Body Parameters

ctoken  string  

Developer token

project_id  string optional  

Developer Project Ids(comma separated)

Developer - Get Associated Projects

requires authentication

list of Associated projects

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/get_associated_project?ctoken=e7ff6070baaa30946ad195e7ea678e9e&limit=10&offset=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"aliquid\",
    \"limit\": 979,
    \"offset\": 1738818450
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/get_associated_project"
);

const params = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "limit": "10",
    "offset": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "aliquid",
    "limit": 979,
    "offset": 1738818450
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/get_associated_project

Query Parameters

ctoken  string  

Developer token

limit  number  

Limit(minimum value 1, max value 1000)

offset  number  

Offset(minimum value 0, max value 2147483647)

Body Parameters

ctoken  string  

limit  integer  

Must be at least 1. Must not be greater than 1000.

offset  integer  

Must be at least 0. Must not be greater than 2147483647.

Developer - Developer Update Associated Project

requires authentication

Developer Update Associated Project

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/update_associated_project" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"aasociated_project_id\": 2,
    \"project_id\": 10
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/update_associated_project"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "aasociated_project_id": 2,
    "project_id": 10
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/update_associated_project

Body Parameters

ctoken  string  

Customer token

aasociated_project_id  number  

project_id  number  

Developer - Developer Project Status Update

requires authentication

Developer Project Status Update

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/Change_project_status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"project_id\": 10,
    \"status\": 0
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/Change_project_status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "project_id": 10,
    "status": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/Change_project_status

Body Parameters

ctoken  string  

Customer token

project_id  number  

status  number  

Developer - list of states

requires authentication

list of states for a developer

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/states?ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c&search_key=mah" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/states"
);

const params = {
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c",
    "search_key": "mah",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v2/states

Query Parameters

ctoken  string  

Developer token

search_key  string optional  

Search Key(by state name)

Developer - list of cities

requires authentication

list of cities for a developer

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/cities?ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c&search_key=mum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/cities"
);

const params = {
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c",
    "search_key": "mum",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v2/cities

Query Parameters

ctoken  string  

Developer token

search_key  string optional  

Search Key(by city name)

Developer - Get Profile Pic

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/get_profile_pic" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/get_profile_pic"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/get_profile_pic

Body Parameters

ctoken  string  

Developer token

Developer - All countries Lists

requires authentication

All countries Lists

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/get_country_list?ctoken=4c98182b4e2685c26e234024db64a713" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/get_country_list"
);

const params = {
    "ctoken": "4c98182b4e2685c26e234024db64a713",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
 "success": true,
 "message": "Country List",
 "data": [
        {
           "id": 2,
           "name": "ALBANIA",
           "iso": "AL",
           "phonecode": 355
       },
       {
           "id": 3,
           "name": "ALGERIA",
           "iso": "DZ",
           "phonecode": 213
       },
       {
           "id": 4,
           "name": "AMERICAN SAMOA",
           "iso": "AS",
           "phonecode": 1684
       },
       {
           "id": 5,
           "name": "ANDORRA",
           "iso": "AD",
           "phonecode": 376
       },
       {
           "id": 8,
           "name": "ANTARCTICA",
           "iso": "AQ",
           "phonecode": 0
       },
       {
           "id": 99,
           "name": "INDIA",
           "iso": "IN",
           "phonecode": 91
       },
]
}
 

Request      

GET v2/get_country_list

Query Parameters

ctoken  string  

Developer token

Developer - All states Lists based on country

requires authentication

All states Lists based on country

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/get_state_list?ctoken=4c98182b4e2685c26e234024db64a713&country_id=99" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/get_state_list"
);

const params = {
    "ctoken": "4c98182b4e2685c26e234024db64a713",
    "country_id": "99",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
 "success": true,
 "message": "State List",
 "data": [
  {
     "id": 47,
      "name": "Andaman Nicobar",
      "country_id": 99
 },
  {
     "id": 45,
      "name": "Arunachal Pradesh",
      "country_id": 99
 },
  {
     "id": 5,
    "name": "Bihar",
     "country_id": 99
  },
  {
      "id": 39,
      "name": "Chandigarh",
      "country_id": 99
 },
  {
      "id": 7,
      "name": "Chhattisgarh",
      "country_id": 99
  },
  {
      "id": 9,
      "name": "Daman and Diu",
      "country_id": 99
  },
  {
      "id": 10,
      "name": "Delhi",
      "country_id": 99
  },
]
}
 

Request      

GET v2/get_state_list

Query Parameters

ctoken  string  

Developer token

country_id  number optional  

country_id is required

Developer - All cities lists based on state

requires authentication

All cities lists based on state

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/get_city_list?ctoken=4c98182b4e2685c26e234024db64a713&state_id=11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/get_city_list"
);

const params = {
    "ctoken": "4c98182b4e2685c26e234024db64a713",
    "state_id": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"success": true,
"message": "City list",
"data": [
   {
       "id": 92,
       "name": "Anjuna"
   },
   {
       "id": 93,
       "name": "Arambol"
   },
   {
       "id": 94,
       "name": "Assolna"
   },
   {
       "id": 103,
       "name": "Bardez"
   },
   {
       "id": 105,
       "name": "Benavalim"
   },
   {
       "id": 106,
       "name": "Bicholim"
   },
   {
       "id": 109,
       "name": "Calangute"
   },
   {
       "id": 110,
       "name": "Canacona"
   },
]
}
 

Request      

GET v2/get_city_list

Query Parameters

ctoken  string  

Developer token

state_id  string  

state_id is required

Developer - list of roles

requires authentication

list of roles

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/roles?ctoken=e3e3e48db7f4f01938fdd6791eaa8e6c" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/roles"
);

const params = {
    "ctoken": "e3e3e48db7f4f01938fdd6791eaa8e6c",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET v2/roles

Query Parameters

ctoken  string  

Developer token

Inventory - Instructions

requires authentication

Used to get Instructions

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/inventory/instructions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 1,
    \"tower_id\": 2,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/instructions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": 1,
    "tower_id": 2,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/inventory/instructions

Body Parameters

project_id  number  

The project_id for which the inventory instructions to be fetched

tower_id  number  

The tower id for which the inventory instructions to be fetched.

ctoken  string  

Customer token

Inventory - Upload

requires authentication

Used to upload inventory CSV file

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/inventory/upload" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "project_id=1" \
    --form "tower_id=2" \
    --form "inventory_upload_id=eligendi" \
    --form "ctoken=bb474260310ae0d3712bf933af67680e" \
    --form "inventory=@/tmp/phpufhb5W" 
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/upload"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('project_id', '1');
body.append('tower_id', '2');
body.append('inventory_upload_id', 'eligendi');
body.append('ctoken', 'bb474260310ae0d3712bf933af67680e');
body.append('inventory', document.querySelector('input[name="inventory"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST v2/inventory/upload

Body Parameters

project_id  number  

The project_id for which the inventory to be uploaded

tower_id  number  

The tower id for which the inventory to be uploaded.

inventory  file  

Inventory csv file.

inventory_upload_id  The optional  

id from list api for which the inventory to be reuploaded.

ctoken  string  

Customer token

Inventory - List

requires authentication

Used to list inventory uploaded

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/inventory/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 1,
    \"tower_id\": 2,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": 1,
    "tower_id": 2,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/inventory/list

Body Parameters

project_id  number  

The project_id for which the inventory to be listed

tower_id  number optional  

The tower id for which the inventory to be listed.

ctoken  string  

Customer token

Inventory - Upload View

requires authentication

Used to get the inventory uploaded

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/inventory/upload_view" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"inventory_upload_id\": 1,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/upload_view"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "inventory_upload_id": 1,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/inventory/upload_view

Body Parameters

inventory_upload_id  number  

The inventory_upload_id for which the inventory to be view

ctoken  string  

Customer token

Inventory - Validate Data

requires authentication

Used to validate the inventory uploaded

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/inventory/validate_data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"inventory_upload_id\": 1,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/validate_data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "inventory_upload_id": 1,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/inventory/validate_data

Body Parameters

inventory_upload_id  number  

The inventory_upload_id for which the inventory to be validate

ctoken  string  

Customer token

Inventory - Confirm Inventory Load

requires authentication

Used to confirm the inventory uploaded

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/inventory/confirm_inventory_load" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"inventory_upload_id\": 1,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/confirm_inventory_load"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "inventory_upload_id": 1,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/inventory/confirm_inventory_load

Body Parameters

inventory_upload_id  number  

The inventory_upload_id for which the inventory to be validate

ctoken  string  

Customer token

Inventory - Inventory View

requires authentication

Used to get the inventory uploaded

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/inventory/inventory_view" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 1,
    \"tower_id\": 1,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/inventory_view"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": 1,
    "tower_id": 1,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/inventory/inventory_view

Body Parameters

project_id  number  

The project_id for which the inventory to be view

tower_id  number  

The tower_id for which the inventory to be view

ctoken  string  

Customer token

Inventory - Get Unit

requires authentication

Used to get the unit data

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/inventory/get_unit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unit_id\": 1,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/get_unit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unit_id": 1,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/inventory/get_unit

Body Parameters

unit_id  number  

The unit_id for which the inventory to get

ctoken  string  

Customer token

Inventory - Add/Update Unit

requires authentication

Used to add/update the unit data

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/inventory/add_unit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unit_id\": 1,
    \"wing\": \"A\",
    \"floor_number\": 2,
    \"unit_number\": \"A-201\",
    \"area\": 700,
    \"property_name\": \"1 bhk deluxe\",
    \"property_sub_type\": \"1 BHK\",
    \"facing\": \"East\",
    \"circle_carpet_price\": 5000,
    \"carpet_price\": 10000,
    \"inventory_status\": 1,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/add_unit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unit_id": 1,
    "wing": "A",
    "floor_number": 2,
    "unit_number": "A-201",
    "area": 700,
    "property_name": "1 bhk deluxe",
    "property_sub_type": "1 BHK",
    "facing": "East",
    "circle_carpet_price": 5000,
    "carpet_price": 10000,
    "inventory_status": 1,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/inventory/add_unit

Body Parameters

unit_id  number optional  

The unit_id for which the inventory to be updated

wing  string optional  

The wing value

floor_number  number optional  

The floor_number value

unit_number  string optional  

The unit_number value

area  number optional  

The area value

property_name  string optional  

The property_name value

property_sub_type  string optional  

The property_sub_type value

facing  string  

The facing value

circle_carpet_price  number  

The circle_carpet_price value

carpet_price  number  

The carpet_price value

inventory_status  number  

The inventory_status value

ctoken  string  

Customer token

Inventory - Get Project Towers

requires authentication

Used to get Project Towers

Example request:
curl --request GET \
    --get "https://api.qa.blox.co.in/developer/v2/inventory/get_project_towers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 1,
    \"ctoken\": \"bb474260310ae0d3712bf933af67680e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/inventory/get_project_towers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": 1,
    "ctoken": "bb474260310ae0d3712bf933af67680e"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET v2/inventory/get_project_towers

Body Parameters

project_id  number  

The project_id for which the Project Towers to be fetched

ctoken  string  

Customer token

Invoice - Get Invoice List

requires authentication

Used to Get Invoice List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/invoice_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"limit\": \"20\",
    \"offset\": \"0\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/invoice_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "limit": "20",
    "offset": "0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice List",
    "data": [
        {
            "id": 21,
            "invoice_no": "12332",
            "booking_id": "O32977220423025506",
            "customer_name": "Suraj mail modo",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "configuration": "1 BHK-303",
            "invoice_amount": "0.00",
            "invoice_by": "CP",
            "invoice_date": "2022-09-22 00:00:00",
            "invoice_total": "0.00",
            "payment_status": "pending",
            "payment_details": null,
            "invoice_status": "Pending",
            "invoice_file_url": ""
        },
        {
            "id": 20,
            "invoice_no": "12332",
            "booking_id": "O32977220423025506",
            "customer_name": "blox",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "configuration": "1 BHK-303",
            "invoice_amount": "0.00",
            "invoice_by": "CP",
            "invoice_date": "2022-09-22 00:00:00",
            "invoice_total": "0.00",
            "payment_status": "Pending",
            "payment_details": null,
            "invoice_status": "Pending",
            "invoice_file_url": ""
        }
    ]
}
 

Request      

POST v2/invoice_list

Body Parameters

ctoken  string  

CP token

limit  numeric optional  

not required limit

offset  numeric optional  

not required offset

Invoice - Get Invoice Details

requires authentication

Used to Get Invoice Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/invoice_detail" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"invoice_id\": 20
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/invoice_detail"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "invoice_id": 20
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice Deatils",
    "data": [
        {
            "id": 1,
            "invoice_no": "12332",
            "invoice_date": "2022-09-22 00:00:00",
            "org_raised_for": "Puranik Builders Limited",
            "org_address": "ass",
            "org_state": {
                "id": "12",
                "name": "Gujarat"
            },
            "org_gst_no": "12BLOXS1234A1BC",
            "biller_org": "sda",
            "biller_address": "dsfdfdfs",
            "biller_state": {
                "id": "11",
                "name": "Goa"
            },
            "biller_gst_no": "AS2213231",
            "notes": "this",
            "customer_name": "Bram yadav",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "invoice_amount": "0.00",
            "created_by_user": "CP",
            "created_by_user_id": 32967,
            "created_for": "blox",
            "developer_id": 1,
            "booking_amount": "200000.00",
            "invoice_file_url": "",
            "invoice_total": "0.00",
            "payment_status": "Pending",
            "invoice_status": "Pending",
            "account_data": {
                "legal_company_name": "Puranik Builders Limited",
                "account_holder_name": "Aldea Annexo",
                "current_account_no": "78999999952",
                "banks_name": "HDFC BANK",
                "ifsc_code": "HDFC0001440",
                "address": "ass"
            }
        }
    ]
}
 

Request      

POST v2/invoice_detail

Body Parameters

ctoken  string  

CP token

invoice_id  integer  

limit

Invoice - Invoice Update

requires authentication

Used to Invoice Update

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/update_invoice" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"invoice_id\": 20,
    \"status\": \"Accepted\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/update_invoice"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "invoice_id": 20,
    "status": "Accepted"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
      "success": true,
      "message": "Invoice updated successfully",
  }
 

Request      

POST v2/update_invoice

Body Parameters

ctoken  string  

CP token

invoice_id  integer  

invoice id

status  string optional  

not required Accepted/Rejected

Endpoints

POST v2/frontEndActivity

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/frontEndActivity" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 3,
    \"user_name\": \"dolorum\",
    \"module\": \"quo\",
    \"module_id\": 15,
    \"sub_module_id\": 6,
    \"sub_sub_module_id\": 10
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/frontEndActivity"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 3,
    "user_name": "dolorum",
    "module": "quo",
    "module_id": 15,
    "sub_module_id": 6,
    "sub_sub_module_id": 10
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/frontEndActivity

Body Parameters

user_id  integer  

user_name  string  

module  string  

module_id  integer  

sub_module_id  integer optional  

sub_sub_module_id  integer optional  

sub_module  string optional  

sub_sub_module  string optional  

data_before_action  string optional  

action  string optional  

ip_address  string optional  

user_agent  string optional  

created_at  string optional  

updated_at  string optional  

POST v2/BackEndActivityLog

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/BackEndActivityLog" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 7,
    \"user_name\": \"consequatur\",
    \"module\": \"ex\",
    \"module_id\": 14,
    \"sub_module_id\": 5,
    \"sub_sub_module_id\": 18
}"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/BackEndActivityLog"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 7,
    "user_name": "consequatur",
    "module": "ex",
    "module_id": 14,
    "sub_module_id": 5,
    "sub_sub_module_id": 18
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v2/BackEndActivityLog

Body Parameters

user_id  integer  

user_name  string  

module  string  

module_id  integer  

module_desc  string optional  

sub_module  string optional  

sub_module_id  integer optional  

sub_module_desc  string optional  

sub_sub_module  string optional  

sub_sub_module_id  integer optional  

sub_sub_module_desc  string optional  

data_before_action  string optional  

action  string optional  

ip_address  string optional  

user_agent  string optional  

created_at  string optional  

updated_at  string optional  

POST v2/api-error

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/developer/v2/api-error" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/developer/v2/api-error"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST v2/api-error

Third Party API Endpoints

Third Party - send sms/whatsapp text

requires authentication

send sms/whatsapp text

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/tp/v1/send-sms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"9599174773\",
    \"content\": \"54845 is the OTP to verify your mobile number with Blox. OTP is valid till 10-08-2022 11:57 AM. Do not share with anyone. Thanks, Blox Team\",
    \"country_code\": 91,
    \"whatsapp_flag\": false,
    \"template_id\": 17174,
    \"placeholders\": \"12345,12-08-2022 07:50AM\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/tp/v1/send-sms"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "9599174773",
    "content": "54845 is the OTP to verify your mobile number with Blox. OTP is valid till 10-08-2022 11:57 AM. Do not share with anyone. Thanks, Blox Team",
    "country_code": 91,
    "whatsapp_flag": false,
    "template_id": 17174,
    "placeholders": "12345,12-08-2022 07:50AM"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/send-sms

Body Parameters

phone  string  

Phone

content  string  

Message

country_code  number  

Mobile of Customer

whatsapp_flag  boolean optional  

Whatsapp Flag

template_id  number optional  

Pinnacle Template Id

placeholders  string optional  

Template Placeholders

CP API Endpoints

CP - Get Profile Details

requires authentication

Used to Get Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_profile"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
{
 "success": true,
 "message": "Profile Details",
 "data": {
     "id": 33550,
     "name": "john",
     "phone": "9448355458",
     "phone_country": 91,
     "email": "tilak.singh1@blox.xyz",
     "dob": "2002-08-08",
     "pincode": "201301",
     "profile_pic": "https://blox-dev-bucket.s3.amazonaws.com/users/310822015003-150722114553-banner1 (1).png",
     "state_id": 7,
     "state_name": "Chhattisgarh",
     "city_id": 256,
     "city_name": "Mumbai",
     "address": "mumbai",
     "is_phone_verified": 0,
     "is_email_verified": 0,
     "is_verified": 0,
     "profile_completed": 0,
     "member_since": "21-03-2022"
 }
}
}
 

Request      

POST v1/get_profile

Body Parameters

ctoken  string  

CP token

CP - Get Country List

requires authentication

Used to Get Country List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_country_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_country_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
 "success": true,
 "message": "Country List",
 "data": [
        {
           "id": 2,
           "name": "ALBANIA",
           "iso": "AL",
           "phonecode": 355
       },
       {
           "id": 3,
           "name": "ALGERIA",
           "iso": "DZ",
           "phonecode": 213
       },
       {
           "id": 4,
           "name": "AMERICAN SAMOA",
           "iso": "AS",
           "phonecode": 1684
       },
       {
           "id": 5,
           "name": "ANDORRA",
           "iso": "AD",
           "phonecode": 376
       },
       {
           "id": 8,
           "name": "ANTARCTICA",
           "iso": "AQ",
           "phonecode": 0
       },
       {
           "id": 99,
           "name": "INDIA",
           "iso": "IN",
           "phonecode": 91
       },
]
}
 

Request      

POST v1/get_country_list

Body Parameters

ctoken  string  

CP token

CP - Get State List

requires authentication

Used to Get State List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_state_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"country_id\": \"99\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_state_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "country_id": "99"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
 "success": true,
 "message": "State List",
 "data": [
  {
     "id": 47,
      "name": "Andaman Nicobar",
      "country_id": 99
 },
  {
     "id": 45,
      "name": "Arunachal Pradesh",
      "country_id": 99
 },
  {
     "id": 5,
    "name": "Bihar",
     "country_id": 99
  },
  {
      "id": 39,
      "name": "Chandigarh",
      "country_id": 99
 },
  {
      "id": 7,
      "name": "Chhattisgarh",
      "country_id": 99
  },
  {
      "id": 9,
      "name": "Daman and Diu",
      "country_id": 99
  },
  {
      "id": 10,
      "name": "Delhi",
      "country_id": 99
  },
]
}
 

Request      

POST v1/get_state_list

Body Parameters

ctoken  string  

CP token

country_id  string  

country_id is required

CP - Get City List

requires authentication

Used to Get City List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_city_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"state_id\": \"11\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_city_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "state_id": "11"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
"success": true,
"message": "City list",
"data": [
   {
       "id": 92,
       "name": "Anjuna"
   },
   {
       "id": 93,
       "name": "Arambol"
   },
   {
       "id": 94,
       "name": "Assolna"
   },
   {
       "id": 103,
       "name": "Bardez"
   },
   {
       "id": 105,
       "name": "Benavalim"
   },
   {
       "id": 106,
       "name": "Bicholim"
   },
   {
       "id": 109,
       "name": "Calangute"
   },
   {
       "id": 110,
       "name": "Canacona"
   },
]
}
 

Request      

POST v1/get_city_list

Body Parameters

ctoken  string  

CP token

state_id  string  

state_id is required

CP - Get Location List

requires authentication

Used to Get Location List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_location_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"pincode\": \"400065\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_location_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "pincode": "400065"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
   "success": true,
   "message": "Location list",
   "data": [
       {
           "id": 1,
           "name": "Aarey Road, Mumbai"
       },
       {
           "id": 193,
           "name": "Royal Palms, Mumbai"
       },
   ]
}
 

Request      

POST v1/get_location_list

Body Parameters

ctoken  string  

CP token

pincode  numeric  

pincode is required

CP - Get Register Type

requires authentication

Used to Get Register Type

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/register_type" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/register_type"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Register Type list",
    "data": {
        "register_type": {
            "private": "Private Ltd.Co.",
            "public": "Public Ltd.Co.",
            "proprietorship": "Proprietorship",
            "partnership": "Partnership",
            "llp": "LLP"
        }
    }
}
 

Request      

POST v1/register_type

Body Parameters

ctoken  string  

CP token

CP - Get Property Types

requires authentication

Used to Get Property Types

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/property_types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/property_types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Property Type list",
    "data": [
        {
            "id": 1,
            "name": "Residential",
            "sort_order": 1
        },
        {
            "id": 2,
            "name": "Commercial",
            "sort_order": 1
        }
    ]
}
 

Request      

POST v1/property_types

Body Parameters

ctoken  string  

CP token

CP - Update Profile Details

requires authentication

Used to Update Profile Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/update_profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "ctoken=e7ff6070baaa30946ad195e7ea678e9e" \
    --form "name=john" \
    --form "dob=2002-08-08" \
    --form "pincode=201301" \
    --form "state_id=7" \
    --form "city_id=256" \
    --form "address=mumbai" \
    --form "profile_pic=@/tmp/phpXKXIxs" 
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/update_profile"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'e7ff6070baaa30946ad195e7ea678e9e');
body.append('name', 'john');
body.append('dob', '2002-08-08');
body.append('pincode', '201301');
body.append('state_id', '7');
body.append('city_id', '256');
body.append('address', 'mumbai');
body.append('profile_pic', document.querySelector('input[name="profile_pic"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Profile updated successfully",
    "data": {
        "name": "john",
        "phone": "9448355458",
        "phone_country": 91,
        "email": "john@example.com",
        "dob": "2002-08-08",
        "pincode": "201301",
        "profile_pic": "https://blox-dev-bucket.s3.ap-south-1.amazonaws.com/users/310822015003-150722114553-banner1%20%281%29.png",
        "state_id": 7,
        "state_name": "Chhattisgarh",
        "city_id": 256,
        "city_name": "Mumbai",
        "address": "mumbai",
        "is_phone_verified": 0,
        "is_email_verified": 0,
        "is_verified": 0,
        "profile_completed": 0,
        "member_since": "19-07-2022"
    }
}
 

Request      

POST v1/update_profile

Body Parameters

ctoken  string  

CP token

name  string optional  

not required Name of the CP and Max Character: 50

dob  date optional  

not required DOB format Y-m-d of the CP

pincode  numeric optional  

not required Pincode of the CP

state_id  integer optional  

not required state of the CP

city_id  integer optional  

not required city of the CP

address  text optional  

not required Address of the CP and Max Character: 255

profile_pic  file  

profile pic [format : 'png', 'jpeg', 'jpg'] and Maximum Size : 5mb

CP - Get Organisation Details

requires authentication

Used to Get Organisation Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_organisation" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_organisation"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP Organisation Details",
    "data": {
        "name": "john",
        "rera_id": "A51900029429",
        "company_name": "Aditya Sharma",
        "brand_name": "Katya Property Consultancy",
        "gst_no": "12BLOXS1234A1BD",
        "pan_no": "FQGPK9805K",
        "tan_no": "XXXM12345X",
        "regd_type": "private",
        "broker_prop_type": "1,2",
        "broker_prop_type_name": "Residential, Commercial",
        "office_address": "MUMBAI",
        "office_phone": "02268770000",
        "office_phone_country": 91
    }
}
 

Request      

POST v1/get_organisation

Body Parameters

ctoken  string  

CP token

CP - Update Organisation Details

requires authentication

Used to Update Organisation Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/update_organisation" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"rera_id\": \"A51900029429\",
    \"company_name\": \"Aditya Sharma\",
    \"brand_name\": \"Katya Property Consultancy\",
    \"gst_no\": \"22AAAA0000A1Z5\",
    \"pan_no\": \"BLOX1234X\",
    \"tan_no\": \"XXXM12345X\",
    \"regd_type\": \"private\",
    \"broker_prop_type\": \"1,2\",
    \"office_address\": \"MUMBAI\",
    \"office_phone\": \"02268770000\",
    \"office_phone_country\": \"91\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/update_organisation"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "rera_id": "A51900029429",
    "company_name": "Aditya Sharma",
    "brand_name": "Katya Property Consultancy",
    "gst_no": "22AAAA0000A1Z5",
    "pan_no": "BLOX1234X",
    "tan_no": "XXXM12345X",
    "regd_type": "private",
    "broker_prop_type": "1,2",
    "office_address": "MUMBAI",
    "office_phone": "02268770000",
    "office_phone_country": "91"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Organisation Details updated successfully",
    "data": {
        "name": "john",
        "rera_id": "A51900029429",
        "company_name": "Aditya Sharma",
        "brand_name": "Katya Property Consultancy",
        "gst_no": "03AADFG1801E1ZA",
        "pan_no": "BRIPG4738B",
        "tan_no": "XXXM12345X",
        "regd_type": "private",
        "broker_prop_type": "1,2",
        "broker_prop_type_name": "Residential, Commercial",
        "office_address": "MUMBAI",
        "office_phone": "02268770000",
        "office_phone_country": 91
    }
}
 

Request      

POST v1/update_organisation

Body Parameters

ctoken  string  

CP token

rera_id  string optional  

not required RERA ID (The RERA ID is twelve character long alpha-numeric unique identifier. The first character is letter, followed by eleven numerals.)

company_name  string optional  

not required CP Company name/ Individual name

brand_name  string optional  

not required CP Brand name

gst_no  string optional  

not required CP GST no.

pan_no  string optional  

not required CP PAN no.

tan_no  string optional  

not required CP TAN no.

regd_type  string optional  

not required CP Register type private/public/proprietorship

broker_prop_type  string optional  

not required CP Broker property type id

office_address  text optional  

not required CP Office Address

office_phone  numeric optional  

not required CP Office No

office_phone_country  numeric optional  

not required CP Office No's Country Code

CP - Get Bank Details

requires authentication

Used to Get bank Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_bank" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_bank"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP Bank Details",
    "data": {
        "account_number": "0001234567890",
        "name": "HDFC Bank",
        "ifsc_code": "HDFC001234",
        "address": "MUMBAI",
        "upi_id": "sammpleupiid@hdfc",
        "payment_method": "bank"
    }
}
 

Request      

POST v1/get_bank

Body Parameters

ctoken  string  

CP token

CP - Get IFSC Bank Detail

requires authentication

Used to Get Bank Detail by IFSC Code

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_ifsc_bank" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"ifsc_code\": \"KKBK0000261\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_ifsc_bank"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "ifsc_code": "KKBK0000261"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "IFSC Bank Details",
    "data": {
        "ifsc_code": "KKBK0000261",
        "bank": "Kotak Mahindra Bank",
        "bank_code": "KKBK",
        "branch": "GURGAON"
    }
}
 

Request      

POST v1/get_ifsc_bank

Body Parameters

ctoken  string  

CP token

ifsc_code  string  

ifsc_code minimun 11 character ifsc Code for bank details

CP - Update Bank Details

requires authentication

Used to Update Bank Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/update_bank" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"name\": \"HDFC Bank\",
    \"account_number\": \"0001234567890\",
    \"ifsc_code\": \"HDFC001234\",
    \"payment_method\": \"bank\",
    \"address\": \"MUMBAI\",
    \"upi_id\": \"sammpleupiid@hdfc\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/update_bank"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "name": "HDFC Bank",
    "account_number": "0001234567890",
    "ifsc_code": "HDFC001234",
    "payment_method": "bank",
    "address": "MUMBAI",
    "upi_id": "sammpleupiid@hdfc"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP-Bank Details saved successfully",
    "data": {
        "account_number": "0001234567890",
        "name": "HDFC Bank",
        "ifsc_code": "HDFC001234",
        "address": "MUMBAI",
        "upi_id": "sammpleupiid@hdfc",
        "payment_method": "bank"
    }
}
 

Request      

POST v1/update_bank

Body Parameters

ctoken  string  

CP token

name  string  

CP Bank Name and Max Character: 50

account_number  numeric  

CP Account Number

ifsc_code  string  

IFSC_Code

payment_method  string optional  

not required CP Payment Method bank/upi

address  text optional  

not required Bank Address and Max Character: 255

upi_id  numeric optional  

not required UPI ID format

CP - Update Interested Location

requires authentication

Used to Update Interested Location

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/update_interested_location" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"location_ids\": \"[]\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/update_interested_location"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "location_ids": "[]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP-Interested Location saved successfully",
    "data": [
        {
            "id": 88,
            "user_id": 33550,
            "location_id": 4
        }
    ]
}
 

Request      

POST v1/update_interested_location

Body Parameters

ctoken  string  

CP token

location_ids  json_array  

CP Interested location_ids ["200","4"]

CP - Get Interested Location

requires authentication

Used to Get Interested Location

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/get_interested_location" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/get_interested_location"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP Interested Location Details",
    "data": [
        {
            "id": 88,
            "user_id": 33550,
            "location_id": 4,
            "location_name": "Amboli, Mumbai"
        }
    ]
}
 

Request      

POST v1/get_interested_location

Body Parameters

ctoken  string  

CP token

CP - Delete Interested Location

requires authentication

Used to Delete Interested Location

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/delete_interested_location" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"id\": \"1\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/delete_interested_location"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "id": "1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP-Interested Location deleted successully",
    "data": []
}
 

Request      

POST v1/delete_interested_location

Body Parameters

ctoken  string  

CP token

id  json_array  

id of CP interested location

POST v1/test_sentry

requires authentication

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/test_sentry" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/test_sentry"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST v1/test_sentry

CP - Add Lead

requires authentication

Used to Add Lead

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/add_lead" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"name\": \"john\",
    \"email\": \"john@example.com\",
    \"mobile\": \"9087654321\",
    \"country_code\": \"91\",
    \"customer_interestedin\": \"[]\",
    \"project_id\": 1,
    \"interaction_comment\": \"voluptatem\",
    \"configuration\": 1,
    \"visit_type\": \"1\",
    \"visit_date\": \"2022-08-22\",
    \"visit_time\": \"10:00:00\",
    \"budget_min\": \"10000\",
    \"budget_max\": \"100000\",
    \"loan_interaction\": \"est\",
    \"loan_amount\": \"inventore\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/add_lead"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "name": "john",
    "email": "john@example.com",
    "mobile": "9087654321",
    "country_code": "91",
    "customer_interestedin": "[]",
    "project_id": 1,
    "interaction_comment": "voluptatem",
    "configuration": 1,
    "visit_type": "1",
    "visit_date": "2022-08-22",
    "visit_time": "10:00:00",
    "budget_min": "10000",
    "budget_max": "100000",
    "loan_interaction": "est",
    "loan_amount": "inventore"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Lead successfully added",
    "data": {
        "user_id": 25672
    }
}
 

Request      

POST v1/add_lead

Body Parameters

ctoken  string  

CP token

name  string  

Name of the Customer

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer's mobile

customer_interestedin  json_string  

Customer Interested in of the lead as json_array ["project","loan"]

project_id  integer  

required if customer interested in project

interaction_comment  text  

interaction for lead

configuration  integer  

project configuration for lead

visit_type  numeric optional  

not required visit_type physical visit = 1 or virtual visit =2

visit_date  date  

visit_date for lead format Y-m-d if customer interested in project

visit_time  time  

visit_time format H:i:s if customer interested in project

budget_min  numeric optional  

not required budget_min for lead

budget_max  numeric optional  

not required budget_max for lead

loan_interaction  text optional  

not required, Case: required when customer interested in Loan lead

loan_amount  numeric optional  

not required, Case: required when customer interested in Loan lead

CP - Get Lead List

requires authentication

Used to Get Lead List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/list_lead" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"status\": \"0\",
    \"search_key\": \"quae\",
    \"lead_status\": \"[]\",
    \"sort_by\": \"expiry_date\",
    \"sort_order\": \"desc\",
    \"limit\": \"10\",
    \"offset\": \"0\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/list_lead"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "status": "0",
    "search_key": "quae",
    "lead_status": "[]",
    "sort_by": "expiry_date",
    "sort_order": "desc",
    "limit": "10",
    "offset": "0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Lead list",
    "data": [
        {
            "lead_id": 1943,
            "lead_type": "project",
            "enquiry_no_id": "E331081663747341",
            "lead_status": {
                "id": null,
                "name": ""
            },
            "customer_id": 33108,
            "customer_name": "Suraj",
            "customer_mobile": "8787878668",
            "customer_email": "suraj.k099@gmail.com",
            "customer_country_code": "91",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "project_data": {
                "id": 1,
                "name": "Kolte-Patil Jai Vijay",
                "address": "Jai Vijay CHSL, Near Airport Authority Colony, Sahar Road, Off Western Express Highway, Vile Parle(East), Mumbai, Maharashtra 400099",
                "latitude": "19.1091764609139",
                "longitude": "72.8542486693134"
            },
            "project_id": 1,
            "project_name": "Kolte-Patil Jai Vijay",
            "book_ride": {
                "id": 1,
                "riderName": "Saurabh",
                "riderMobile": "9131048806",
                "bookingDate": "2022-09-02",
                "bookingTime": "10:11:00"
            },
            "configurations": "1 BHK123",
            "location_name": "Sahar",
            "lead_expiring_in": 22,
            "lead_created": "21-09-2022 01:32 PM",
            "visit_status": "Visit Requested",
            "site_visit_date": "22-08-2022 10:00 AM",
            "follow_up": "23-09-2022 01:50 PM",
            "lost_date": "21-09-2022 01:50 PM",
            "incentive": "0",
            "interaction": [
                {
                    "enquiry_no_id": "E331081663747341",
                    "comment": "this is interaction",
                    "created_date": "21-09-2022 01:37 PM",
                    "follow_up_date": "23-09-2022 01:37 PM",
                    "updated_by_type": "CP",
                    "updated_by_name": "CP",
                    "department": "CP",
                    "profile_pic": "https://dev.blox.co.in/assets2/images/icon_user.png",
                    "lead_status": {
                        "id": null,
                        "name": ""
                    }
                },
                {
                    "enquiry_no_id": "E331081663747341",
                    "comment": "this is interaction",
                    "created_date": "21-09-2022 01:33 PM",
                    "follow_up_date": "23-09-2022 01:33 PM",
                    "updated_by_type": "CP",
                    "updated_by_name": "CP",
                    "department": "CP",
                    "profile_pic": "https://dev.blox.co.in/assets2/images/icon_user.png",
                    "lead_status": {
                        "id": null,
                        "name": ""
                    }
                },
                {
                    "enquiry_no_id": "E331081663747341",
                    "comment": "this is interaction",
                    "created_date": "21-09-2022 01:33 PM",
                    "follow_up_date": "23-09-2022 01:33 PM",
                    "updated_by_type": "CP",
                    "updated_by_name": "CP",
                    "department": "CP",
                    "profile_pic": "https://dev.blox.co.in/assets2/images/icon_user.png",
                    "lead_status": {
                        "id": null,
                        "name": ""
                    }
                },
                {
                    "enquiry_no_id": "E331081663747341",
                    "comment": "this is interaction",
                    "created_date": "21-09-2022 01:32 PM",
                    "follow_up_date": "23-09-2022 01:32 PM",
                    "updated_by_type": "CP",
                    "updated_by_name": "CP",
                    "department": "CP",
                    "profile_pic": "https://dev.blox.co.in/assets2/images/icon_user.png",
                    "lead_status": {
                        "id": null,
                        "name": ""
                    }
                }
            ]
        },
        {
            "lead_id": 1940,
            "lead_type": "project",
            "enquiry_no_id": "E330601662538958",
            "lead_status": {
                "id": null,
                "name": ""
            },
            "customer_id": 33060,
            "customer_name": "Suraj",
            "customer_mobile": "8191045042",
            "customer_email": "suraj@gmail.com",
            "customer_country_code": "91",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "project_data": null,
            "project_id": "",
            "project_name": "",
            "book_ride": null,
            "configurations": null,
            "location_name": "",
            "lead_expiring_in": 8,
            "lead_created": "07-09-2022 01:52 PM",
            "visit_status": "",
            "site_visit_date": "",
            "follow_up": "",
            "lost_date": "07-09-2022 01:52 PM",
            "incentive": "0",
            "interaction": [
                {
                    "enquiry_no_id": "E330601662538958",
                    "comment": "lnteraction for loan",
                    "created_date": "07-09-2022 01:52 PM",
                    "follow_up_date": "09-09-2022 01:52 PM",
                    "updated_by_type": "Broker",
                    "updated_by_name": "Broker",
                    "department": "",
                    "profile_pic": "https://dev.blox.co.in/assets2/images/icon_user.png",
                    "lead_status": {
                        "id": null,
                        "name": ""
                    }
                }
            ]
        }
    ]
}
 

Request      

POST v1/list_lead

Body Parameters

ctoken  string  

CP token

status  numeric  

Active=0/Expired=1

search_key  string optional  

not required search_key Customer Name, Project Name, Location Name Example:

lead_status  json_string optional  

not required lead_status id in multiple for filter json_array ["294","305"]

sort_by  string optional  

not required sort_by expiry_date/lost

sort_order  string optional  

not required sort_order asc/desc

limit  numerice optional  

not required limit

offset  numerice optional  

not required offset

CP - Get Lead Calendar Data

requires authentication

Used to Get Calendar Data

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/lead_calendar" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"lead_id\": 1797,
    \"month\": \"01\",
    \"year\": \"2022\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/lead_calendar"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "lead_id": 1797,
    "month": "01",
    "year": "2022"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Lead calendar activity Detail",
    "data": {
        "calendar_data": [
            {
                "date": "16-09-2022",
                "activity": [
                    {
                        "project_id": 2,
                        "project_name": "Kalpataru Vienta new name",
                        "location_name": "Kandivali East, Mumbai",
                        "action_datetime": "16-09-2022 02:50 PM",
                        "lead_status_id": 314,
                        "lead_status": "In Follow Up",
                        "lead_status_short": "FU"
                    }
                ]
            },
            {
                "date": "20-09-2022",
                "activity": [
                    {
                        "project_id": 2,
                        "project_name": "Kalpataru Vienta new name",
                        "location_name": "Kandivali East, Mumbai",
                        "action_datetime": "20-09-2022 12:53 PM",
                        "lead_status_id": 390,
                        "lead_status": "Meeting Proposed",
                        "lead_status_short": "MP"
                    }
                ]
            }
        ]
    }
}
 

Request      

POST v1/lead_calendar

Body Parameters

ctoken  string  

CP token

lead_id  integer  

lead_id ex: 1797

month  numeric  

month no ex: 01

year  numeric  

year = 2022

CP - Get Lead Details

requires authentication

Used to Get Lead Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/lead_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"lead_id\": \"1\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/lead_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "lead_id": "1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Lead Detail",
    "data": {
        "lead_id": 1805,
        "enquiry_no_id": "E329901650878643",
        "lead_status": {
            "id": 314,
            "name": "In Follow Up"
        },
        "project_name": "Kalpataru Vienta new name",
        "configurations": "",
        "location_name": "Kandivali East",
        "lead_created": "25-04-2022 02:54 PM",
        "site_visit_date": "25-04-2022 02:54 PM",
        "follow_up": "28-04-2022 10:40 AM",
        "lost_date": "28-04-2022 10:41 AM",
        "incentive": "0",
        "loan_amount": null,
        "min_budget": "",
        "max_budget": "",
        "interaction": [
            {
                "enquiry_no_id": "E329901650878643",
                "comment": "testt",
                "created_date": "28-04-2022 10:41 AM",
                "follow_up_date": "28-04-2022 10:40 AM",
                "updated_by_type": null,
                "updated_by_name": "Blox  Super Admin",
                "department": "superadmin",
                "profile_pic": "",
                "lead_status": {
                    "id": 314,
                    "name": "In Follow Up"
                }
            },
            {
                "enquiry_no_id": "E329901650878643",
                "comment": "Project :'Aldea Annexo' shortlisted by 'Blox  Super Admin'",
                "created_date": "28-04-2022 10:40 AM",
                "follow_up_date": "",
                "updated_by_type": "Backend",
                "updated_by_name": "Blox  Super Admin",
                "department": "superadmin",
                "profile_pic": "",
                "lead_status": {
                    "id": null,
                    "name": ""
                }
            },
            {
                "enquiry_no_id": "E329901650878643",
                "comment": "Project :'Kolte-Patil Jai Vijay' shortlisted by 'Blox  Super Admin'",
                "created_date": "28-04-2022 10:40 AM",
                "follow_up_date": "",
                "updated_by_type": "Backend",
                "updated_by_name": "Blox  Super Admin",
                "department": "superadmin",
                "profile_pic": "",
                "lead_status": {
                    "id": null,
                    "name": ""
                }
            },
            {
                "enquiry_no_id": "E329901650878643",
                "comment": "RM \"Tech  Test\" has been assigned",
                "created_date": "28-04-2022 10:40 AM",
                "follow_up_date": "",
                "updated_by_type": "Backend",
                "updated_by_name": "Blox  Super Admin",
                "department": "superadmin",
                "profile_pic": "",
                "lead_status": {
                    "id": null,
                    "name": ""
                }
            },
            {
                "enquiry_no_id": "E329901650878643",
                "comment": "Project :'Kalpataru Vienta' shortlisted by 'Raman Test'",
                "created_date": "25-04-2022 02:54 PM",
                "follow_up_date": "",
                "updated_by_type": "Backend",
                "updated_by_name": "Blox  Super Admin",
                "department": "",
                "profile_pic": "",
                "lead_status": {
                    "id": null,
                    "name": ""
                }
            },
            {
                "enquiry_no_id": "E329901650878643",
                "comment": "Physical site visit by customer",
                "created_date": "25-04-2022 02:54 PM",
                "follow_up_date": "27-04-2022 02:54 PM",
                "updated_by_type": "Backend",
                "updated_by_name": "Blox  Super Admin",
                "department": "superadmin",
                "profile_pic": "",
                "lead_status": {
                    "id": null,
                    "name": ""
                }
            }
        ],
        "basic_details": {
            "id": 32990,
            "profile_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "name": "Raman Test",
            "phone": "7543535454",
            "country_code": "91",
            "email": "",
            "pincode": "",
            "city": {
                "id": null,
                "name": ""
            },
            "state": {
                "id": null,
                "name": ""
            }
        },
        "project_details": {
            "project_id": 2,
            "project_name": "Kalpataru Vienta new name",
            "developer": "Kalpataru Limited",
            "configurations": "",
            "created_date": "25-04-2022 02:54 PM"
        }
    }
}
 

Request      

POST v1/lead_details

Body Parameters

ctoken  string  

CP token

lead_id  numeric  

CP - Get Lead Statuses

requires authentication

Used to Get Lead Statuses

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/lead_statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/lead_statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
"success": true,
"message": "Lead Filter List",
"data": {
 "lead_statuses": [
     {
          "id": 294,
          "name": "Booking Done",
          "slug": ""
     },
     {
          "id": 305,
          "name": "Booking Propose",
          "slug": ""
     },
     {
          "id": 310,
          "name": "Closure Meeting",
          "slug": ""
     },
     {
          "id": 314,
          "name": "In Follow Up",
          "slug": ""
     },
     {
          "id": 326,
          "name": "Incoming",
          "slug": ""
     },
  ],
  "sort_by": {
      "expiry_date": "Expiry Date",
      "lost": "Lost"
  }
}
}
 

Request      

POST v1/lead_statuses

Body Parameters

ctoken  string  

CP token

CP - Add New Lead Interaction

requires authentication

Used to Add New Lead Interaction

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/add_interaction" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"lead_id\": \"11003\",
    \"comment\": \"this is comment\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/add_interaction"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "lead_id": "11003",
    "comment": "this is comment"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
"success": true,
"message": "Lead interaction added successfully",
}
 

Request      

POST v1/add_interaction

Body Parameters

ctoken  string  

CP token

lead_id  numeric  

lead_id

comment  text  

comment

CP - Cancelled Visit

requires authentication

Used to Cancelled Visit

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/cancelled_visit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"lead_id\": 11003,
    \"project_id\": 1
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/cancelled_visit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "lead_id": 11003,
    "project_id": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
"success": true,
"message": "Visit has been cancelled successfully",
}
 

Request      

POST v1/cancelled_visit

Body Parameters

ctoken  string  

CP token

lead_id  integer  

lead_id

project_id  integer  

project_id

CP - Reschedule Visit

requires authentication

Used to Reschedule Visit

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/reschdule_visit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"lead_id\": 11003,
    \"project_id\": 1,
    \"configuration\": 1,
    \"visit_date\": \"2022-08-22\",
    \"visit_time\": \"10:00:00\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/reschdule_visit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "lead_id": 11003,
    "project_id": 1,
    "configuration": 1,
    "visit_date": "2022-08-22",
    "visit_time": "10:00:00"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
"success": true,
"message": "Visit has been reschduled successfully",
}
 

Request      

POST v1/reschdule_visit

Body Parameters

ctoken  string  

CP token

lead_id  integer  

lead_id

project_id  integer  

project_id

configuration  integer  

configuration

visit_date  date  

visit_date for lead format Y-m-d

visit_time  time  

visit_time format H:i:s

CP - Get Profile Completion Percentage

requires authentication

Used to Get Profile Completion Percentage

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/profile_completion_percentage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/profile_completion_percentage"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/profile_completion_percentage

Body Parameters

ctoken  string  

CP token

CP - Get Dashboard

requires authentication

Used to Get Dashboard

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/dashboard" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/dashboard"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP Dashboard",
    "data": {
        "site_visit_completed": 0,
        "total_bookings_done": 0,
        "brokerage_overview": {
            "brokerage_show": false,
            "earned": 0,
            "received": 0,
            "in_process": 0,
            "pending_to_be_raised": 0
        },
        "lead_generation_count": [
            {
                "month": "Sep",
                "site_visits_done_count": 0,
                "site_visits_scheduled_count": 0
            },
            {
                "month": "Aug",
                "site_visits_done_count": 0,
                "site_visits_scheduled_count": 0
            },
            {
                "month": "Jul",
                "site_visits_done_count": 0,
                "site_visits_scheduled_count": 0
            }
        ],
        "upcomming_event": {
            "upcomming_event_available": false,
            "event_type": "Site Visit",
            "customer_name": "",
            "site_visit_date": "",
            "site_visit_time": ""
        }
    }
}
 

Request      

POST v1/dashboard

Body Parameters

ctoken  string  

CP token

CP - Get Upcoming Events

requires authentication

Used to Get Upcoming Events

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/upcoming_events" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"from_date\": \"2022-09-13\",
    \"to_date\": \"2022-09-13\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/upcoming_events"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "from_date": "2022-09-13",
    "to_date": "2022-09-13"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP Upcomming Event",
    "data": {
        "upcomming_event": {
            "2022-04-23": [
                {
                    "event_type": "Site Visit",
                    "date": "2022-04-23",
                    "time": "10:09:34",
                    "customer_data": {
                        "id": 32987,
                        "name": "Anmol one"
                    },
                    "project_data": {
                        "id": 11,
                        "project_name": "Artesia - Residential Wing"
                    }
                },
                {
                    "event_type": "Site Visit",
                    "date": "2022-04-23",
                    "time": "10:18:05",
                    "customer_data": {
                        "id": 32988,
                        "name": "Ram User"
                    },
                    "project_data": {
                        "id": 11,
                        "project_name": "Artesia - Residential Wing"
                    }
                }
            ],
            "2022-04-24": [
                {
                    "event_type": "Site Visit",
                    "date": "2022-04-24",
                    "time": "10:30:00",
                    "customer_data": {
                        "id": 32983,
                        "name": "sham New two"
                    },
                    "project_data": {
                        "id": 2,
                        "project_name": "Kalpataru Vienta new name"
                    }
                }
            ],
            "2022-04-25": [
                {
                    "event_type": "Site Visit",
                    "date": "2022-04-25",
                    "time": "12:26:35",
                    "customer_data": {
                        "id": 32989,
                        "name": "Deepak two"
                    },
                    "project_data": {
                        "id": 2,
                        "project_name": "Kalpataru Vienta new name"
                    }
                },
                {
                    "event_type": "Site Visit",
                    "date": "2022-04-25",
                    "time": "14:54:03",
                    "customer_data": {
                        "id": 32990,
                        "name": "Raman Test"
                    },
                    "project_data": {
                        "id": 2,
                        "project_name": "Kalpataru Vienta new name"
                    }
                }
            ]
        }
    }
}
 

Request      

POST v1/upcoming_events

Body Parameters

ctoken  string  

CP token

from_date  date  

start date for filter date format Y-m-d

to_date  date  

end date for filter date format Y-m-d

CP - Get Lead Generation Count

requires authentication

Used to Get Lead Generation Count

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/lead_generation_count" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"filter_by\": \"date\",
    \"project_id\": \"1\",
    \"time_period\": \"yearly\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/lead_generation_count"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "filter_by": "date",
    "project_id": "1",
    "time_period": "yearly"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP Lead Generation Count",
    "data": {
        "lead_generation_count": [
            [
                {
                    "month_name": "Jul",
                    "month_key": "07-2022",
                    "site_visits_scheduled": {
                        "count": 0
                    },
                    "site_visit_done": {
                        "count": 0
                    }
                },
                {
                    "month_name": "Aug",
                    "month_key": "08-2022",
                    "site_visits_scheduled": {
                        "count": 0
                    },
                    "site_visit_done": {
                        "count": 2
                    }
                },
                {
                    "month_name": "Sep",
                    "month_key": "09-2022",
                    "site_visits_scheduled": {
                        "count": 0
                    },
                    "site_visit_done": {
                        "count": 3
                    }
                }
            ]
        ]
    }
}
 

Request      

POST v1/lead_generation_count

Body Parameters

ctoken  string  

CP token

filter_by  string  

filter_by ex- date/project

project_id  interger optional  

not required, Case: project_id required when filter_by selected project

time_period  string optional  

not required time_period ex- past_3_month/quarterly/yearly

CP - Get Lead Generation Projects

requires authentication

Used to Get Lead Generation Projects

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/lead_generation_projects" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/lead_generation_projects"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "CP Lead Generation Projects",
    "data": {
        "projects": [
            {
                "id": 1,
                "name": "Kolte-Patil Jai Vijay"
            },
            {
                "id": 2,
                "name": "Kalpataru Vienta new name"
            },
            {
                "id": 11,
                "name": "Artesia - Residential Wing"
            },
            {
                "id": 14,
                "name": "Aldea Annexo"
            },
            {
                "id": 63,
                "name": "19 North"
            }
        ]
    }
}
 

Request      

POST v1/lead_generation_projects

Body Parameters

ctoken  string  

CP token

CP - Get Property Stats

requires authentication

Used to Get Property Stats

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/property_stats" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"project_id\": \"1\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/property_stats"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "project_id": "1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST v1/property_stats

Body Parameters

ctoken  string  

CP token

project_id  numeric  

CP project_id

CP - Get Booking List

requires authentication

Used to Get Booking List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/booking_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"search_key\": \"et\",
    \"type\": \"Book\",
    \"payment_status\": \"[]\",
    \"sort_by\": \"desc\",
    \"limit\": \"20\",
    \"offset\": \"0\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/booking_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "search_key": "et",
    "type": "Book",
    "payment_status": "[]",
    "sort_by": "desc",
    "limit": "20",
    "offset": "0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Booking list",
    "type": "Book",
    "data": [
        {
            "id": 500,
            "booking_id": "O33101220915071758",
            "booking_type": "Book",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "customer_name": "Anmol",
            "customer_email": "suraj.k@ehostinguk.com",
            "customer_mobile": "8191045045",
            "project_name": "Kolte-Patil Jai Vijay",
            "configuration": "3 BHK",
            "location": "Sahar, Mumbai",
            "area": 860,
            "rera_id": "P51700000295",
            "booked_amount": "10000",
            "booking_date": "15-09-2022 07:17 PM",
            "agreement_value": "1000000.00",
            "brokerage": 0,
            "order_status": "pending",
            "payment_status": "Pending",
            "payment_mode": "",
            "payment_method": "",
            "rm_data": {
                "id": 41,
                "name": "Arti  ",
                "phone": "8965231254",
                "email": "artiagraiya1998@gmail.com",
                "is_deleted": 0,
                "profile_pic": "https://dev.blox.co.in/assets2/images/icon_user.png"
            }
        },
        {
            "id": 499,
            "booking_id": "O33101220912043017",
            "booking_type": "Book",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "customer_name": "Anmol",
            "customer_email": "suraj.k@ehostinguk.com",
            "customer_mobile": "8191045045",
            "project_name": "Kolte-Patil Jai Vijay",
            "configuration": "3 BHK",
            "location": "Sahar, Mumbai",
            "area": 860,
            "rera_id": "P51700000295",
            "booked_amount": "10000",
            "booking_date": "12-09-2022 04:30 PM",
            "agreement_value": "1000000.00",
            "brokerage": 0,
            "order_status": "pending",
            "payment_status": "Pending",
            "payment_mode": "",
            "payment_method": "",
            "rm_data": {
                "id": 41,
                "name": "Arti  ",
                "phone": "8965231254",
                "email": "artiagraiya1998@gmail.com",
                "is_deleted": 0,
                "profile_pic": "https://dev.blox.co.in/assets2/images/icon_user.png"
            }
        },
        {
            "id": 498,
            "booking_id": "O33101220912015627",
            "booking_type": "Book",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "customer_name": "Anmol",
            "customer_email": "suraj.k@ehostinguk.com",
            "customer_mobile": "8191045045",
            "project_name": "Kolte-Patil Jai Vijay",
            "configuration": "3 BHK",
            "location": "Sahar, Mumbai",
            "area": 860,
            "rera_id": "P51700000295",
            "booked_amount": "10000",
            "booking_date": "12-09-2022 01:56 PM",
            "agreement_value": "1000000.00",
            "brokerage": 0,
            "order_status": "pending",
            "payment_status": "Pending",
            "payment_mode": "",
            "payment_method": "",
            "rm_data": {
                "id": 41,
                "name": "Arti  ",
                "phone": "8965231254",
                "email": "artiagraiya1998@gmail.com",
                "is_deleted": 0,
                "profile_pic": "https://dev.blox.co.in/assets2/images/icon_user.png"
            }
        }
    ]
}
 

Request      

POST v1/booking_list

Body Parameters

ctoken  string  

CP token

search_key  string optional  

not required search_key Customer Name, Project Name, Location Name Example:

type  string  

booking type Book/EOI/Cancelled

payment_status  json_string optional  

not required payment_status for Booking filter payment_status id in multiple for filter json_array ["Pending","Successful","Failed"] Get data from Booking Filter API

sort_by  string  

sort_by asc/desc

limit  numeric optional  

not required limit

offset  numeric optional  

not required offset

CP - Get Booking Filter

requires authentication

Used to Get Booking Filter

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/booking_filter" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/booking_filter"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Booking Filter list",
    "data": {
        "payment_status_arr": {
            "Successful": "Successful",
            "Pending": "Pending",
            "Failed": "Failed"
        },
        "eoi_amount_sort_by": {
            "desc": "Agreement value - High to Low",
            "asc": "Agreement value - Low to High"
        }
    }
}
 

Request      

POST v1/booking_filter

Body Parameters

ctoken  string  

CP token

CP - Get Booking Details

requires authentication

Used to Get Booking Details

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/booking_detail" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"id\": 23221
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/booking_detail"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "id": 23221
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Booking Details",
    "data": {
        "booking_id": "O33101220912015448",
        "booking_date": "12-09-2022 01:54 PM",
        "booking_type": "Book",
        "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
        "customer_name": "Anmol",
        "customer_email": "suraj.k@ehostinguk.com",
        "customer_mobile": "8191045045",
        "order_status": "pending",
        "payment_status": "Pending",
        "booked_amount": "10000",
        "payment_mode": "",
        "payment_method": "",
        "track_status": [],
        "project_name": "Kolte-Patil Jai Vijay",
        "project_media_file": "https://blox-dev-bucket.s3.amazonaws.com/projects/thumb/Kolte-Patil_Developers_Limited-Kolte-Patil_Jai_Vijay--Bedroom-1636967962.jpg",
        "developer_media_file": "",
        "is_assured": 0,
        "is_exclusive": 1,
        "location_name": "Sahar, Mumbai",
        "configuration": "3 BHK",
        "agreement_price": "1000000.00",
        "brokerage": 0,
        "area": 860,
        "rera_id": "P51700000295",
        "tower_name": "",
        "unit_no": "",
        "brokerage_percent": "0.00",
        "transaction_history": []
    }
}
 

Request      

POST v1/booking_detail

Body Parameters

ctoken  string  

CP token

id  integer  

Customer Booking ID

CP - Add EOI

requires authentication

Used to Add EOI

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/add_eoi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "ctoken=e7ff6070baaa30946ad195e7ea678e9e" \
    --form "user_id=330321" \
    --form "name=john" \
    --form "email=john@example.com" \
    --form "mobile=9087654321" \
    --form "country_code=91" \
    --form "project_id=1" \
    --form "tower_id=7" \
    --form "unit_no=1" \
    --form "property_type=11" \
    --form "pay_type=cheque" \
    --form "bank_name=SBI" \
    --form "account_no=1200000332" \
    --form "cheque_no=12233231" \
    --form "cheque_date=2022-08-03" \
    --form "cheque_amount=100000" \
    --form "cheque_file=@/tmp/phpQFcfoU" 
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/add_eoi"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'e7ff6070baaa30946ad195e7ea678e9e');
body.append('user_id', '330321');
body.append('name', 'john');
body.append('email', 'john@example.com');
body.append('mobile', '9087654321');
body.append('country_code', '91');
body.append('project_id', '1');
body.append('tower_id', '7');
body.append('unit_no', '1');
body.append('property_type', '11');
body.append('pay_type', 'cheque');
body.append('bank_name', 'SBI');
body.append('account_no', '1200000332');
body.append('cheque_no', '12233231');
body.append('cheque_date', '2022-08-03');
body.append('cheque_amount', '100000');
body.append('cheque_file', document.querySelector('input[name="cheque_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "EOI successfully added",
    "data": {
        "order_no_id": "O33101220915071758"
    }
}
 

Request      

POST v1/add_eoi

Body Parameters

ctoken  string  

CP token

user_id  integer  

Name of the user_id

name  string  

Name of the Customer

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

project_id  numeric  

project_id of the EOI

tower_id  numeric  

tower_id of the EOI

unit_no  numeric  

unit_no of the EOI

property_type  numeric  

property_type id of the EOI

pay_type  string  

pay_type of the EOI online/cheque/pos

bank_name  string  

bank_name of the EOI

account_no  string  

account_no

cheque_no  string  

cheque_no of the EOI

cheque_date  string  

cheque_date of the EOI

cheque_amount  string  

cheque_amount of the EOI

cheque_file  file  

cheque_file [format : 'pdf'] and Maximum Size : 5mb

CP - Add Booking

requires authentication

Used to Add Booking

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/add_book" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "ctoken=e7ff6070baaa30946ad195e7ea678e9e" \
    --form "user_id=31333" \
    --form "name=john" \
    --form "email=john@example.com" \
    --form "mobile=9087654321" \
    --form "country_code=91" \
    --form "project_id=1" \
    --form "tower_id=7" \
    --form "unit_no=1" \
    --form "property_type=11" \
    --form "pay_type=cheque" \
    --form "bank_name=SBI" \
    --form "account_no=1200000332" \
    --form "cheque_no=12233231" \
    --form "cheque_date=2022-08-03" \
    --form "cheque_amount=100000" \
    --form "cheque_file=@/tmp/phpZzeugm" 
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/add_book"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'e7ff6070baaa30946ad195e7ea678e9e');
body.append('user_id', '31333');
body.append('name', 'john');
body.append('email', 'john@example.com');
body.append('mobile', '9087654321');
body.append('country_code', '91');
body.append('project_id', '1');
body.append('tower_id', '7');
body.append('unit_no', '1');
body.append('property_type', '11');
body.append('pay_type', 'cheque');
body.append('bank_name', 'SBI');
body.append('account_no', '1200000332');
body.append('cheque_no', '12233231');
body.append('cheque_date', '2022-08-03');
body.append('cheque_amount', '100000');
body.append('cheque_file', document.querySelector('input[name="cheque_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Booking successfully added",
    "data": {
        "order_no_id": "O33101220915071758"
    }
}
 

Request      

POST v1/add_book

Body Parameters

ctoken  string  

CP token

user_id  interger  

id of the Customer

name  string  

Name of the Customer

email  string  

Email of the Customer

mobile  numeric  

Mobile of the Customer

country_code  numeric  

Country Code of the Customer

project_id  numeric  

project_id of the EOI

tower_id  numeric  

tower_id of the EOI

unit_no  numeric  

unit_no of the EOI

property_type  numeric  

property_type id of the EOI

pay_type  string  

pay_type of the EOI online/cheque/pos

bank_name  string  

bank_name of the EOI

account_no  string  

account_no

cheque_no  string  

cheque_no of the EOI

cheque_date  string  

cheque_date of the EOI

cheque_amount  string  

cheque_amount of the EOI

cheque_file  file  

cheque_file [format : 'pdf'] and Maximum Size : 5mb

CP - Get Overview Invoice

requires authentication

Used to Get Overview Invoice

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/overview_invoice" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/overview_invoice"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Overview Invoice",
    "data": {
        "brokerage": {
            "accured": "102000.00",
            "billed": "100000.00",
            "collect": 0,
            "pending": 100000,
            "brokerage_month_wise": [
                {
                    "month": "Oct",
                    "month_year": "10-2022",
                    "received_amount": 0,
                    "pending_amount": 0
                },
                {
                    "month": "Sep",
                    "month_year": "09-2022",
                    "received_amount": "0.00",
                    "pending_amount": "90000.00"
                },
                {
                    "month": "Aug",
                    "month_year": "08-2022",
                    "received_amount": "0.00",
                    "pending_amount": "10000.00"
                },
                {
                    "month": "Jul",
                    "month_year": "07-2022",
                    "received_amount": 0,
                    "pending_amount": 0
                },
                {
                    "month": "Jun",
                    "month_year": "06-2022",
                    "received_amount": 0,
                    "pending_amount": 0
                },
                {
                    "month": "May",
                    "month_year": "05-2022",
                    "received_amount": 0,
                    "pending_amount": 0
                },
                {
                    "month": "Apr",
                    "month_year": "04-2022",
                    "received_amount": 0,
                    "pending_amount": 0
                }
            ]
        }
    }
}
 

Request      

POST v1/overview_invoice

Body Parameters

ctoken  string  

CP token

CP - Get Recent Invoice List

requires authentication

Used to Get Recent Invoice List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/recent_invoice" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"limit\": \"20\",
    \"offset\": \"0\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/recent_invoice"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "limit": "20",
    "offset": "0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Recent Invoice",
    "data": [
        {
            "id": 16,
            "customer_name": "Bram yadav",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "invoice_no": "12332",
            "invoice_date": "2022-09-22 00:00:00",
            "invoice_amount": "10000.00",
            "invoice_total": "11800.00",
            "payment_status": "",
            "invoice_status": "Pending"
        },
        {
            "id": 15,
            "customer_name": "",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "invoice_no": "12332",
            "invoice_date": "2022-09-22 00:00:00",
            "invoice_amount": "10000.00",
            "invoice_total": "11800.00",
            "payment_status": "",
            "invoice_status": "Pending"
        },
        {
            "id": 14,
            "customer_name": "Bram yadav",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "invoice_no": "12332",
            "invoice_date": "2022-09-22 00:00:00",
            "invoice_amount": "10000.00",
            "invoice_total": "11800.00",
            "payment_status": "",
            "invoice_status": "Pending"
        }
    ]
}
 

Request      

POST v1/recent_invoice

Body Parameters

ctoken  string  

CP token

limit  numeric optional  

not required limit

offset  numeric optional  

not required offset

CP - Get Invoice List

requires authentication

Used to Invoice List

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/invoice_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"search_key\": \"optio\",
    \"invoice_for\": \"Book\",
    \"invoice_status\": \"Pending\",
    \"tab_name\": \"Raise\",
    \"sort_by\": \"desc\",
    \"limit\": \"20\",
    \"offset\": \"0\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/invoice_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "search_key": "optio",
    "invoice_for": "Book",
    "invoice_status": "Pending",
    "tab_name": "Raise",
    "sort_by": "desc",
    "limit": "20",
    "offset": "0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice list",
    "tab_name": "Manage",
    "data": [
        {
            "id": 506,
            "booking_id": "O33110220926041103",
            "booking_type": "Book",
            "lead_id": 1948,
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "customer_name": "Bram yadav",
            "customer_email": "samizaidi@ehostinguk.com",
            "customer_mobile": "9900104504",
            "project_name": "Satellite Elegance",
            "configuration": "1",
            "location": "Gokuldam, Mumbai",
            "area": 1200,
            "rera_id": "P51700025841",
            "booked_amount": "20000",
            "booking_date": "26-09-2022 04:11 PM",
            "agreement_value": "200000.00",
            "brokerage": 20000,
            "brokerage_percentage": "10.00",
            "order_status": "Initiated",
            "payment_status": "Pending",
            "payment_mode": "Cheque",
            "payment_method": "Cheque",
            "invoice_id": 6,
            "invoice_no": "12332",
            "invoice_status": "Pending",
            "invoice_file_url": ""
        },
        {
            "id": 507,
            "booking_id": "O33110220926041152",
            "booking_type": "Book",
            "lead_id": 1948,
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "customer_name": "Bram yadav",
            "customer_email": "samizaidi@ehostinguk.com",
            "customer_mobile": "9900104504",
            "project_name": "Satellite Elegance",
            "configuration": "1",
            "location": "Gokuldam, Mumbai",
            "area": 1200,
            "rera_id": "P51700025841",
            "booked_amount": "20000",
            "booking_date": "26-09-2022 04:11 PM",
            "agreement_value": "200000.00",
            "brokerage": 20000,
            "brokerage_percentage": "10.00",
            "order_status": "Initiated",
            "payment_status": "Pending",
            "payment_mode": "Cheque",
            "payment_method": "Cheque",
            "invoice_id": 9,
            "invoice_no": "12332",
            "invoice_status": "In-progress",
            "invoice_file_url": ""
        },
        {
            "id": 510,
            "booking_id": "O33110220926041234",
            "booking_type": "Book",
            "lead_id": 1948,
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "customer_name": "Bram yadav",
            "customer_email": "samizaidi@ehostinguk.com",
            "customer_mobile": "9900104504",
            "project_name": "Satellite Elegance",
            "configuration": "1",
            "location": "Gokuldam, Mumbai",
            "area": 1200,
            "rera_id": "P51700025841",
            "booked_amount": "20000",
            "booking_date": "26-09-2022 04:12 PM",
            "agreement_value": "200000.00",
            "brokerage": 20000,
            "brokerage_percentage": "10.00",
            "order_status": "Initiated",
            "payment_status": "Pending",
            "payment_mode": "Cheque",
            "payment_method": "Cheque",
            "invoice_id": 12,
            "invoice_no": "12332",
            "invoice_status": "Pending",
            "invoice_file_url": ""
        }
    ]
}
 

Request      

POST v1/invoice_list

Body Parameters

ctoken  string  

CP token

search_key  string optional  

not required search_key Customer Name, Project Name, Location Name Example:

invoice_for  string  

booking type Book/EOI

invoice_status  string  

invoice_status Pending/Paid

tab_name  string  

booking type Raise/Manage

sort_by  string  

sort_by asc/desc

limit  numeric optional  

not required limit

offset  numeric optional  

not required offset

CP - Get Track Invoice Status

requires authentication

Used to Get Track Invoice Status

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/track_invoice_status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"invoice_id\": 1
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/track_invoice_status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "invoice_id": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Track Invoice Status",
    "data": [
        {
            "invoice_id": 9,
            "action": "In-progress",
            "action_date": "2022-10-03T13:44:33.000000Z"
        },
        {
            "invoice_id": 9,
            "action": "In-progress",
            "action_date": "2022-10-03T13:49:01.000000Z"
        }
    ]
}
 

Request      

POST v1/track_invoice_status

Body Parameters

ctoken  string  

CP token

invoice_id  integer  

invoice_id token

CP - Create Invoice

requires authentication

Used to Create Invoice

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/create_invoice" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"order_id\": \"O33101220915071758\",
    \"invoice_no\": \"10000232\",
    \"invoice_date\": \"2002-08-08\",
    \"unit_no\": \"2\",
    \"notes\": \"sed\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/create_invoice"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "order_id": "O33101220915071758",
    "invoice_no": "10000232",
    "invoice_date": "2002-08-08",
    "unit_no": "2",
    "notes": "sed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice created successfully",
    "data": {
        "invoice_id": "10",
        "created_by_user": "CP",
        "created_by_user_id": 32967,
        "created_for": "blox",
        "developer_id": 13,
        "invoice_no": "12332",
        "invoice_date": "2022-09-22 00:00:00",
        "invoice_amount": "0.00",
        "org_raised_for": "Puranik Builders Limited",
        "org_address": "ass",
        "org_state": {
            "id": "12",
            "name": "Gujarat"
        },
        "org_gst_no": "12BLOXS1234A1BC",
        "biller_org": "sda",
        "biller_address": "dsfdfdfs",
        "biller_state": {
            "id": "11",
            "name": "Goa"
        },
        "biller_gst_no": "AS2213231",
        "biller_pan_no": "",
        "json_data": {
            "project_name": "Aldea Annexo",
            "bank_details": {
                "account_number": "12133",
                "bank_name": "sbi",
                "ifsc_code": "4433",
                "address": ""
            },
            "sac_code": ""
        },
        "igst_percentage": "18",
        "cgst_percentage": "0",
        "sgst_percentage": "0",
        "igst_amount": "0.00",
        "cgst_amount": "0.00",
        "sgst_amount": "0.00",
        "invoice_total": "0.00",
        "notes": "this",
        "payment_status": "Pending",
        "invoice_status": "Pending",
        "order_details": {
            "order_id": "O33110220926041152",
            "unit_no": "",
            "agreement_value": "200000.00",
            "agreement_date": null,
            "fee_percentage": "200000.00"
        }
    }
}
 

Request      

POST v1/create_invoice

Body Parameters

ctoken  string  

CP token

order_id  string  

order_id

invoice_no  string  

invoice_no token

invoice_date  date  

invoice_date formate Y-m-d

unit_no  string  

unit_no

notes  string optional  

not required notes token Example:

CP - Invoice file Upload

requires authentication

Used to Invoice file Upload

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/invoice_upload" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "ctoken=e7ff6070baaa30946ad195e7ea678e9e" \
    --form "invoice_id=12" \
    --form "invoice_file=@/tmp/phpuNUNtO" 
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/invoice_upload"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('ctoken', 'e7ff6070baaa30946ad195e7ea678e9e');
body.append('invoice_id', '12');
body.append('invoice_file', document.querySelector('input[name="invoice_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice upload successfully",
    "data": {
        "id": "2",
        "invoice_file_url": "https://blox-dev-bucket.s3.ap-south-1.amazonaws.com/cp_invoice/061022011551-sample.pdf"
    }
}
 

Request      

POST v1/invoice_upload

Body Parameters

ctoken  string  

CP token

invoice_id  integer  

invoice_id

invoice_file  file  

profile pic [format : 'pdf'] and Maximum Size : 5mb

CP - Update Invoice

requires authentication

Used to Update Invoice

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/update_invoice" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"invoice_id\": 12,
    \"order_id\": \"O33101220915071758\",
    \"invoice_no\": \"10000232\",
    \"invoice_date\": \"2002-08-08\",
    \"unit_no\": \"2\",
    \"notes\": \"molestias\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/update_invoice"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "invoice_id": 12,
    "order_id": "O33101220915071758",
    "invoice_no": "10000232",
    "invoice_date": "2002-08-08",
    "unit_no": "2",
    "notes": "molestias"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice updated successfully",
    "data": {
        "invoice_id": "10",
        "created_by_user": "CP",
        "created_by_user_id": 32967,
        "created_for": "blox",
        "developer_id": 13,
        "invoice_no": "12332",
        "invoice_date": "2022-09-22 00:00:00",
        "invoice_amount": "0.00",
        "org_raised_for": "Puranik Builders Limited",
        "org_address": "ass",
        "org_state": {
            "id": "12",
            "name": "Gujarat"
        },
        "org_gst_no": "12BLOXS1234A1BC",
        "biller_org": "sda",
        "biller_address": "dsfdfdfs",
        "biller_state": {
            "id": "11",
            "name": "Goa"
        },
        "biller_gst_no": "AS2213231",
        "biller_pan_no": "",
        "json_data": {
            "project_name": "Aldea Annexo",
            "bank_details": {
                "account_number": "12133",
                "bank_name": "sbi",
                "ifsc_code": "4433",
                "address": ""
            },
            "sac_code": ""
        },
        "igst_percentage": "18",
        "cgst_percentage": "0",
        "sgst_percentage": "0",
        "igst_amount": "0.00",
        "cgst_amount": "0.00",
        "sgst_amount": "0.00",
        "invoice_total": "0.00",
        "notes": "this",
        "payment_status": "Pending",
        "invoice_status": "Pending",
        "order_details": {
            "order_id": "O33110220926041152",
            "unit_no": "",
            "agreement_value": "200000.00",
            "agreement_date": null,
            "fee_percentage": "200000.00"
        }
    }
}
 

Request      

POST v1/update_invoice

Body Parameters

ctoken  string  

CP token

invoice_id  integer  

invoice_id

order_id  string  

order_id

invoice_no  string  

invoice_no token

invoice_date  date  

invoice_date formate Y-m-d

unit_no  string  

unit_no

notes  string optional  

not required notes token Example:

CP - Get Invoice Filter

requires authentication

Used to Get Invoice Filter

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/filter_invoice" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\"
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/filter_invoice"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice Filter Data",
    "data": {
        "invoice_status": {
            "Accepted": "Accepted",
            "In-process": "In-process",
            "Rejected": "Rejected",
            "Paid": "Paid"
        },
        "invoice_for": {
            "eoi": "EOI",
            "Book": "Book"
        },
        "sort_by": {
            "desc": "Latest invoice raised",
            "asc": "Oldest invoice raised"
        }
    }
}
 

Request      

POST v1/filter_invoice

Body Parameters

ctoken  string  

CP token

CP - Get Invoice Detail

requires authentication

Used to Get Invoice Detail

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/invoice_detail" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"invoice_id\": 2
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/invoice_detail"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "invoice_id": 2
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice Details successfully",
    "data": [
        {
            "id": 2,
            "customer_name": "Bram yadav",
            "customer_image": "https://dev.blox.co.in/assets2/images/icon_user.png",
            "project_name": "Kolte-Patil Jai Vijay",
            "configuration": "1",
            "location": "Sahar",
            "brokerage_amount": "",
            "invoice_no": "12332",
            "invoice_date": "2022-09-22 00:00:00",
            "invoice_amount": "10000.00",
            "invoice_total": "11800.00",
            "invoice_status": "Pending",
            "payment_status": "",
            "payment_mode": "",
            "payment_date": "",
            "utr_number": "",
            "payment_done_for": "Book"
        }
    ]
}
 

Request      

POST v1/invoice_detail

Body Parameters

ctoken  string  

CP token

invoice_id  integer  

invoice_id token

CP - View Invoice

requires authentication

Used to View Invoice

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/view_invoice" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"invoice_id\": 10
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/view_invoice"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "invoice_id": 10
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "View Invoice successfully",
    "data": {
        "invoice_id": "10",
        "created_by_user": "CP",
        "created_by_user_id": 32967,
        "created_for": "blox",
        "developer_id": 13,
        "invoice_no": "12332",
        "invoice_date": "2022-09-22 00:00:00",
        "invoice_amount": "0.00",
        "org_raised_for": "Puranik Builders Limited",
        "org_address": "ass",
        "org_state": {
            "id": "12",
            "name": "Gujarat"
        },
        "org_gst_no": "12BLOXS1234A1BC",
        "biller_org": "sda",
        "biller_address": "dsfdfdfs",
        "biller_state": {
            "id": "11",
            "name": "Goa"
        },
        "biller_gst_no": "AS2213231",
        "biller_pan_no": "",
        "json_data": {
            "project_name": "Aldea Annexo",
            "bank_details": {
                "account_number": "12133",
                "bank_name": "sbi",
                "ifsc_code": "4433",
                "address": ""
            },
            "sac_code": ""
        },
        "igst_percentage": "18",
        "cgst_percentage": "0",
        "sgst_percentage": "0",
        "igst_amount": "0.00",
        "cgst_amount": "0.00",
        "sgst_amount": "0.00",
        "invoice_total": "0.00",
        "notes": "this",
        "payment_status": "Pending",
        "invoice_status": "Pending",
        "order_details": {
            "order_id": "O33110220926041152",
            "unit_no": "",
            "agreement_value": "200000.00",
            "agreement_date": null,
            "fee_percentage": "200000.00"
        }
    }
}
 

Request      

POST v1/view_invoice

Body Parameters

ctoken  string  

CP token

invoice_id  integer  

invoice_id

CP - Cancelled Invoice

requires authentication

Used to Cancelled Invoice

Example request:
curl --request POST \
    "https://api.qa.blox.co.in/cp/v1/cancelled_invoice" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ctoken\": \"e7ff6070baaa30946ad195e7ea678e9e\",
    \"invoice_id\": 4
}"
const url = new URL(
    "https://api.qa.blox.co.in/cp/v1/cancelled_invoice"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ctoken": "e7ff6070baaa30946ad195e7ea678e9e",
    "invoice_id": 4
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "success": true,
    "message": "Invoice cancelled successfully"
}
 

Request      

POST v1/cancelled_invoice

Body Parameters

ctoken  string  

CP token

invoice_id  integer  

invoice_id