MENU navbar-image

Introduction

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

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Ads

Get ads

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/ads?keys[]=homepage-banner&keys[]=sidebar-banner" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"keys\": [
        \"homepage-banner\",
        \"sidebar-banner\"
    ]
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/ads"
);

const params = {
    "keys[0]": "homepage-banner",
    "keys[1]": "sidebar-banner",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "keys": [
        "homepage-banner",
        "sidebar-banner"
    ]
};

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": false,
    "data": [],
    "message": null
}

Request      

GET api/v1/ads

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

keys   string[]  optional  

Array of ad keys to filter by.

Body Parameters

keys   string[]  optional  

Array of ad keys to filter by.

Authentication

Register

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Smith\",
    \"name\": \"architecto\",
    \"email\": \"[email protected]\",
    \"password\": \"|]|{+-\",
    \"phone\": \"architecto\",
    \"password_confirmation\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/register"
);

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

let body = {
    "first_name": "John",
    "last_name": "Smith",
    "name": "architecto",
    "email": "[email protected]",
    "password": "|]|{+-",
    "phone": "architecto",
    "password_confirmation": "architecto"
};

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

Example response (200):


{
    "error": false,
    "data": null,
    "message": "Registered successfully! We emailed you to verify your account!"
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name field is required."
        ],
        "email": [
            "The email field is required."
        ],
        "password": [
            "The password field is required."
        ]
    }
}

Request      

POST api/v1/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string  optional  

The first name of the user. This field is required when name is not present. Must not be greater than 120 characters. Must be at least 2 characters. Example: John

last_name   string  optional  

The last name of the user. This field is required when name is not present. Must not be greater than 120 characters. Must be at least 2 characters. Example: Smith

name   string   

The name of the user. Example: architecto

email   string   

The email of the user. Example: [email protected]

password   string   

The password of user to create. Example: |]|{+-

phone   string   

The phone of the user. Example: architecto

password_confirmation   string   

The password confirmation. Example: architecto

Login

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"|]|{+-\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/login"
);

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

let body = {
    "email": "[email protected]",
    "password": "|]|{+-"
};

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

Example response (200):


{
    "error": false,
    "data": {
        "token": "1|aF5s7p3xxx1lVL8hkSrPN72m4wPVpTvTs..."
    },
    "message": null
}

Request      

POST api/v1/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: [email protected]

password   string   

The password of user to create. Example: |]|{+-

Check email existing or not

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/email/check" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/email/check"
);

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

let body = {
    "email": "[email protected]"
};

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

Example response (200):


{
    "error": false,
    "data": {
        "exists": true
    },
    "message": null
}

Request      

POST api/v1/email/check

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: [email protected]

Forgot password

Send a reset link to the given user.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/password/forgot" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/password/forgot"
);

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

let body = {
    "email": "[email protected]"
};

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

Request      

POST api/v1/password/forgot

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: [email protected]

Resend email verification

Resend the email verification notification.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/resend-verify-account-email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/resend-verify-account-email"
);

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

let body = {
    "email": "[email protected]"
};

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

Request      

POST api/v1/resend-verify-account-email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: [email protected]

Logout

requires authentication

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/logout"
);

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

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

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/logout

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Blog

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/search"
);

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

let body = {
    "q": "architecto"
};

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

Example response (200):


{
    "error": false,
    "data": {
        "items": [
            {
                "id": 1,
                "title": "Sample Post",
                "slug": "sample-post",
                "excerpt": "This is a sample post excerpt"
            }
        ],
        "query": "sample",
        "count": 1
    }
}

Example response (400):


{
    "error": true,
    "message": "No search result"
}

List posts

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/posts?per_page=16&page=16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/posts"
);

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

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

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

Example response (200):


{
    "error": false,
    "data": [
        {
            "id": 1,
            "title": "Sample Post",
            "slug": "sample-post",
            "excerpt": "This is a sample post excerpt",
            "content": "Full post content here...",
            "published_at": "2023-01-01T00:00:00.000000Z",
            "author": {
                "id": 1,
                "name": "John Doe"
            },
            "categories": [],
            "tags": []
        }
    ],
    "message": null
}

Request      

GET api/v1/posts

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

The number of items to return per page (default: 10). Example: 16

page   integer  optional  

The page number to retrieve (default: 1). Example: 16

List tags

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/tags?per_page=16&page=16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/tags"
);

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

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

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

Example response (200):


{
    "error": false,
    "data": [
        {
            "id": 1,
            "name": "Laravel",
            "slug": "laravel",
            "description": "PHP Framework for web development",
            "created_at": "2023-01-01T00:00:00.000000Z"
        }
    ],
    "message": null
}

Request      

GET api/v1/tags

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

The number of items to return per page (default: 10). Example: 16

page   integer  optional  

The page number to retrieve (default: 1). Example: 16

Filters posts

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/posts/filters?page=16&per_page=16&search=architecto&after=architecto&author=architecto&author_exclude=architecto&before=architecto&exclude=architecto&include=architecto&order=architecto&order_by=architecto&categories=architecto&categories_exclude=architecto&tags=architecto&tags_exclude=architecto&featured=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/posts/filters"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "after": "architecto",
    "author": "architecto",
    "author_exclude": "architecto",
    "before": "architecto",
    "exclude": "architecto",
    "include": "architecto",
    "order": "architecto",
    "order_by": "architecto",
    "categories": "architecto",
    "categories_exclude": "architecto",
    "tags": "architecto",
    "tags_exclude": "architecto",
    "featured": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/posts/filters?page=1",
        "last": "https://homzen.botble.com/api/v1/posts/filters?page=1",
        "prev": "https://homzen.botble.com/api/v1/posts/filters?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 1,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/posts/filters?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/posts/filters?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/posts/filters",
        "per_page": 16,
        "to": null,
        "total": 0
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/posts/filters

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set.Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

after   string  optional  

Limit response to posts published after a given ISO8601 compliant date. Example: architecto

author   string  optional  

Limit result set to posts assigned to specific authors. Example: architecto

author_exclude   string  optional  

Ensure result set excludes posts assigned to specific authors. Example: architecto

before   string  optional  

Limit response to posts published before a given ISO8601 compliant date. Example: architecto

exclude   string  optional  

Ensure result set excludes specific IDs. Example: architecto

include   string  optional  

Limit result set to specific IDs. Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: desc .One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: updated_at. One of: author, created_at, updated_at, id, slug, title Example: architecto

categories   string  optional  

Limit result set to all items that have the specified term assigned in the categories taxonomy. Example: architecto

categories_exclude   string  optional  

Limit result set to all items except those that have the specified term assigned in the categories taxonomy. Example: architecto

tags   string  optional  

Limit result set to all items that have the specified term assigned in the tags taxonomy. Example: architecto

tags_exclude   string  optional  

Limit result set to all items except those that have the specified term assigned in the tags taxonomy. Example: architecto

featured   string  optional  

Limit result set to items that are sticky. Example: architecto

Get post by slug

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/posts/architecto?slug=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/posts/architecto"
);

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

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Not found"
}

Request      

GET api/v1/posts/{slug}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

slug   string   

The slug of the post. Example: architecto

Query Parameters

slug   string  optional  

Find by slug of post. Example: architecto

Device Tokens

Register or update device token

Register a new device token or update an existing one for push notifications.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/device-tokens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"architecto\",
    \"platform\": \"architecto\",
    \"app_version\": \"architecto\",
    \"device_id\": \"architecto\",
    \"user_type\": \"architecto\",
    \"user_id\": 16
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/device-tokens"
);

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

let body = {
    "token": "architecto",
    "platform": "architecto",
    "app_version": "architecto",
    "device_id": "architecto",
    "user_type": "architecto",
    "user_id": 16
};

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

Request      

POST api/v1/device-tokens

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

The FCM device token. Example: architecto

platform   string  optional  

The device platform (android, ios). Example: architecto

app_version   string  optional  

The app version. Example: architecto

device_id   string  optional  

The unique device identifier. Example: architecto

user_type   string  optional  

The user type (customer, admin). Example: architecto

user_id   integer  optional  

The user ID. Example: 16

Get user's device tokens

Retrieve all device tokens for the authenticated user.

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/device-tokens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/device-tokens"
);

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

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

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/device-tokens

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Update device token

Update an existing device token.

Example request:
curl --request PUT \
    "https://homzen.botble.com/api/v1/device-tokens/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"platform\": \"architecto\",
    \"app_version\": \"architecto\",
    \"device_id\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/device-tokens/564"
);

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

let body = {
    "platform": "architecto",
    "app_version": "architecto",
    "device_id": "architecto"
};

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

Request      

PUT api/v1/device-tokens/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the device token. Example: 564

Body Parameters

platform   string  optional  

The device platform (android, ios). Example: architecto

app_version   string  optional  

The app version. Example: architecto

device_id   string  optional  

The unique device identifier. Example: architecto

Delete device token by token value

Delete a device token using the token value.

Example request:
curl --request DELETE \
    "https://homzen.botble.com/api/v1/device-tokens/by-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/device-tokens/by-token"
);

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

let body = {
    "token": "architecto"
};

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

Request      

DELETE api/v1/device-tokens/by-token

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

The FCM device token to delete. Example: architecto

Delete device token

Delete a device token to stop receiving push notifications.

Example request:
curl --request DELETE \
    "https://homzen.botble.com/api/v1/device-tokens/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/device-tokens/564"
);

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

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

Request      

DELETE api/v1/device-tokens/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the device token. Example: 564

Deactivate device token

Deactivate a device token without deleting it.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/device-tokens/564/deactivate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/device-tokens/564/deactivate"
);

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

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

Request      

POST api/v1/device-tokens/{id}/deactivate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the device token. Example: 564

Languages

Get list of available languages

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/languages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/languages"
);

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

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

Example response (200):


{
    "error": false,
    "data": [
        {
            "lang_id": 1,
            "lang_name": "English",
            "lang_locale": "en",
            "lang_code": "en_US",
            "lang_flag": "<svg ...>",
            "lang_is_default": true,
            "lang_is_rtl": false,
            "lang_order": 0
        },
        {
            "lang_id": 2,
            "lang_name": "Vietnamese",
            "lang_locale": "vi",
            "lang_code": "vi",
            "lang_flag": "<svg ...>",
            "lang_is_default": false,
            "lang_is_rtl": false,
            "lang_order": 1
        }
    ],
    "message": null
}

Request      

GET api/v1/languages

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Get current language

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/languages/current" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/languages/current"
);

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

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

Example response (200):


{
    "error": false,
    "data": {
        "lang_id": 1,
        "lang_name": "English",
        "lang_locale": "en",
        "lang_code": "en_US",
        "lang_flag": "us",
        "lang_is_default": true,
        "lang_is_rtl": false,
        "lang_order": 0
    },
    "message": null
}

Request      

GET api/v1/languages/current

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Notifications

Get user notifications

Retrieve notifications for the authenticated user.

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/notifications?page=1&per_page=20&unread_only=&type=general" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/notifications"
);

const params = {
    "page": "1",
    "per_page": "20",
    "unread_only": "0",
    "type": "general",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/notifications

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Page number for pagination. Example: 1

per_page   integer  optional  

Number of notifications per page (max 50). Example: 20

unread_only   boolean  optional  

Filter to show only unread notifications. Example: false

type   string  optional  

Filter by notification type. Example: general

Get notification statistics

Get notification statistics for the authenticated user.

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/notifications/stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/notifications/stats"
);

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

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

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/notifications/stats

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Mark all notifications as read

Mark all notifications as read for the authenticated user.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/notifications/mark-all-read" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/notifications/mark-all-read"
);

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

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

Request      

POST api/v1/notifications/mark-all-read

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Mark notification as read

Mark a specific notification as read for the authenticated user.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/notifications/564/read" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/notifications/564/read"
);

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

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

Request      

POST api/v1/notifications/{id}/read

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the notification. Example: 564

Mark notification as clicked

Mark a notification as clicked when user taps on it.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/notifications/564/clicked" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/notifications/564/clicked"
);

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

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

Request      

POST api/v1/notifications/{id}/clicked

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the notification. Example: 564

Delete notification

Delete a notification from user's list.

Example request:
curl --request DELETE \
    "https://homzen.botble.com/api/v1/notifications/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/notifications/564"
);

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

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

Request      

DELETE api/v1/notifications/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the notification. Example: 564

Page

List pages

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/pages?per_page=16&page=16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/pages"
);

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

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

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

Example response (200):


{
    "error": false,
    "data": [
        {
            "id": 1,
            "title": "About Us",
            "slug": "about-us",
            "content": "This is the about us page content...",
            "published_at": "2023-01-01T00:00:00.000000Z"
        }
    ],
    "message": null
}

Request      

GET api/v1/pages

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

The number of items to return per page (default: 10). Example: 16

page   integer  optional  

The page number to retrieve (default: 1). Example: 16

Get page by ID

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/pages/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/pages/16"
);

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

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

Example response (200):


{
    "error": false,
    "data": {
        "id": 1,
        "title": "About Us",
        "slug": "about-us",
        "content": "This is the about us page content...",
        "published_at": "2023-01-01T00:00:00.000000Z"
    },
    "message": null
}

Example response (404):


{
    "error": true,
    "message": "Not found"
}

Request      

GET api/v1/pages/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the page to retrieve. Example: 16

Profile

Get the user profile information.

requires authentication

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/me"
);

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

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

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/me

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Update profile

requires authentication

Example request:
curl --request PUT \
    "https://homzen.botble.com/api/v1/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"bngz\",
    \"last_name\": \"miyv\",
    \"name\": \"architecto\",
    \"phone\": \"architecto\",
    \"dob\": \"architecto\",
    \"gender\": \"architecto\",
    \"description\": \"Eius et animi quos velit et.\",
    \"email\": \"[email protected]\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/me"
);

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

let body = {
    "first_name": "bngz",
    "last_name": "miyv",
    "name": "architecto",
    "phone": "architecto",
    "dob": "architecto",
    "gender": "architecto",
    "description": "Eius et animi quos velit et.",
    "email": "[email protected]"
};

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

Request      

PUT api/v1/me

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string  optional  

This field is required when name is not present. Must not be greater than 120 characters. Must be at least 2 characters. Example: bngz

last_name   string  optional  

This field is required when name is not present. Must not be greater than 120 characters. Must be at least 2 characters. Example: miyv

name   string   

Name. Example: architecto

phone   string   

Phone. Example: architecto

dob   date  optional  

nullable Date of birth (format: Y-m-d). Example: architecto

gender   string  optional  

Gender (male, female, other). Example: architecto

description   string  optional  

Description Example: Eius et animi quos velit et.

email   string  optional  

Email. Example: [email protected]

Update Avatar

requires authentication

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/update/avatar" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "avatar=@/tmp/phpt43hkt9g30mi05T0GpH" 
const url = new URL(
    "https://homzen.botble.com/api/v1/update/avatar"
);

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

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

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

Request      

POST api/v1/update/avatar

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

avatar   file   

Avatar file. Example: /tmp/phpt43hkt9g30mi05T0GpH

Update password

requires authentication

Example request:
curl --request PUT \
    "https://homzen.botble.com/api/v1/update/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"|]|{+-\",
    \"old_password\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/update/password"
);

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

let body = {
    "password": "|]|{+-",
    "old_password": "architecto"
};

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

Request      

PUT api/v1/update/password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

password   string   

The new password of user. Example: |]|{+-

old_password   string   

The current password of user. Example: architecto

Get user settings

requires authentication

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/settings"
);

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

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

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/settings

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Update user settings

requires authentication

Example request:
curl --request PUT \
    "https://homzen.botble.com/api/v1/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"biometric_enabled\": false,
    \"notification_enabled\": false,
    \"language\": \"architecto\",
    \"currency\": \"architecto\",
    \"theme\": \"architecto\",
    \"timezone\": \"America\\/Hermosillo\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/settings"
);

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

let body = {
    "biometric_enabled": false,
    "notification_enabled": false,
    "language": "architecto",
    "currency": "architecto",
    "theme": "architecto",
    "timezone": "America\/Hermosillo"
};

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

Request      

PUT api/v1/settings

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

biometric_enabled   boolean  optional  

Enable/disable biometric authentication. Example: false

notification_enabled   boolean  optional  

Enable/disable notifications. Example: false

language   string  optional  

User's preferred language. Example: architecto

currency   string  optional  

User's preferred currency. Example: architecto

theme   string  optional  

User's preferred theme (light, dark, auto). Example: architecto

timezone   string  optional  

User's timezone. Example: America/Hermosillo

Real Estate

List categories

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/categories?page=16&per_page=16&search=architecto&parent_id=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/categories"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "parent_id": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/categories?page=1",
        "last": "https://homzen.botble.com/api/v1/categories?page=1",
        "prev": "https://homzen.botble.com/api/v1/categories?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 1,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/categories?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/categories?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/categories",
        "per_page": 16,
        "to": null,
        "total": 6
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/categories

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

parent_id   string  optional  

Filter by parent category ID. Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: asc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: order. One of: created_at, updated_at, name, order Example: architecto

Get category filters

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/categories/filters?parent_id=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/categories/filters"
);

const params = {
    "parent_id": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Apartment",
            "description": null,
            "status": {
                "value": "published",
                "label": "Published"
            },
            "order": 0,
            "is_default": 1,
            "parent_id": 0,
            "created_at": "2025-01-16T02:39:08.000000Z",
            "updated_at": "2025-01-16T02:39:08.000000Z",
            "url": "https://homzen.botble.com/property-category/apartment",
            "slug": "apartment"
        },
        {
            "id": 2,
            "name": "Villa",
            "description": null,
            "status": {
                "value": "published",
                "label": "Published"
            },
            "order": 1,
            "is_default": 0,
            "parent_id": 0,
            "created_at": "2025-01-16T02:39:08.000000Z",
            "updated_at": "2025-01-16T02:39:08.000000Z",
            "url": "https://homzen.botble.com/property-category/villa",
            "slug": "villa"
        },
        {
            "id": 3,
            "name": "Condo",
            "description": null,
            "status": {
                "value": "published",
                "label": "Published"
            },
            "order": 2,
            "is_default": 0,
            "parent_id": 0,
            "created_at": "2025-01-16T02:39:08.000000Z",
            "updated_at": "2025-01-16T02:39:08.000000Z",
            "url": "https://homzen.botble.com/property-category/condo",
            "slug": "condo"
        },
        {
            "id": 4,
            "name": "House",
            "description": null,
            "status": {
                "value": "published",
                "label": "Published"
            },
            "order": 3,
            "is_default": 0,
            "parent_id": 0,
            "created_at": "2025-01-16T02:39:08.000000Z",
            "updated_at": "2025-01-16T02:39:08.000000Z",
            "url": "https://homzen.botble.com/property-category/house",
            "slug": "house"
        },
        {
            "id": 5,
            "name": "Land",
            "description": null,
            "status": {
                "value": "published",
                "label": "Published"
            },
            "order": 4,
            "is_default": 0,
            "parent_id": 0,
            "created_at": "2025-01-16T02:39:08.000000Z",
            "updated_at": "2025-01-16T02:39:08.000000Z",
            "url": "https://homzen.botble.com/property-category/land",
            "slug": "land"
        },
        {
            "id": 6,
            "name": "Commercial property",
            "description": null,
            "status": {
                "value": "published",
                "label": "Published"
            },
            "order": 5,
            "is_default": 0,
            "parent_id": 0,
            "created_at": "2025-01-16T02:39:08.000000Z",
            "updated_at": "2025-01-16T02:39:08.000000Z",
            "url": "https://homzen.botble.com/property-category/commercial-property",
            "slug": "commercial-property"
        }
    ],
    "error": false,
    "message": null
}

Request      

GET api/v1/categories/filters

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

parent_id   string  optional  

Filter by parent category ID. Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: asc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: order. One of: created_at, updated_at, name, order Example: architecto

Get category by slug

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/categories/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/categories/architecto"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Category not found"
}

Request      

GET api/v1/categories/{slug}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

slug   string   

The slug of the category. Example: architecto

List properties

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/properties?page=16&per_page=16&search=architecto&type=architecto&city_id=architecto&state_id=architecto&country_id=16&category_id=architecto&project_id=architecto&min_price=architecto&max_price=architecto&min_square=architecto&max_square=architecto&number_bedroom=16&number_bathroom=16&number_floor=16&features=architecto&facilities=architecto&is_featured=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/properties"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "type": "architecto",
    "city_id": "architecto",
    "state_id": "architecto",
    "country_id": "16",
    "category_id": "architecto",
    "project_id": "architecto",
    "min_price": "architecto",
    "max_price": "architecto",
    "min_square": "architecto",
    "max_square": "architecto",
    "number_bedroom": "16",
    "number_bathroom": "16",
    "number_floor": "16",
    "features": "architecto",
    "facilities": "architecto",
    "is_featured": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/properties?page=1",
        "last": "https://homzen.botble.com/api/v1/properties?page=4",
        "prev": "https://homzen.botble.com/api/v1/properties?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 4,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/properties?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/properties?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/properties?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/properties?page=3",
                "label": "3",
                "page": 3,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/properties?page=4",
                "label": "4",
                "page": 4,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/properties",
        "per_page": 16,
        "to": null,
        "total": 61
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/properties

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

type   string  optional  

Filter by property type (sale, rent). Example: architecto

city_id   string  optional  

Filter by city ID. Example: architecto

state_id   string  optional  

Filter by state ID. Example: architecto

country_id   integer  optional  

Filter by country ID. Example: 16

category_id   string  optional  

Filter by category ID. Example: architecto

project_id   string  optional  

Filter by project ID. Example: architecto

min_price   string  optional  

Filter by minimum price. Example: architecto

max_price   string  optional  

Filter by maximum price. Example: architecto

min_square   string  optional  

Filter by minimum square footage. Example: architecto

max_square   string  optional  

Filter by maximum square footage. Example: architecto

number_bedroom   integer  optional  

Filter by number of bedrooms. Example: 16

number_bathroom   integer  optional  

Filter by number of bathrooms. Example: 16

number_floor   integer  optional  

Filter by number of floors. Example: 16

features   string  optional  

Filter by feature IDs (comma-separated). Example: architecto

facilities   string  optional  

Filter by facility IDs (comma-separated). Example: architecto

is_featured   string  optional  

Filter by featured properties (1 or 0). Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: desc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: created_at. One of: created_at, updated_at, name, price Example: architecto

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/properties/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/properties/search"
);

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

let body = {
    "q": "architecto"
};

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

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}

Get property filters

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/properties/filters?page=16&per_page=16&search=architecto&type=architecto&city_id=architecto&state_id=architecto&country_id=16&category_id=architecto&project_id=architecto&min_price=architecto&max_price=architecto&min_square=architecto&max_square=architecto&number_bedroom=16&number_bathroom=16&number_floor=16&features=architecto&facilities=architecto&is_featured=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/properties/filters"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "type": "architecto",
    "city_id": "architecto",
    "state_id": "architecto",
    "country_id": "16",
    "category_id": "architecto",
    "project_id": "architecto",
    "min_price": "architecto",
    "max_price": "architecto",
    "min_square": "architecto",
    "max_square": "architecto",
    "number_bedroom": "16",
    "number_bathroom": "16",
    "number_floor": "16",
    "features": "architecto",
    "facilities": "architecto",
    "is_featured": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/properties/filters?page=1",
        "last": "https://homzen.botble.com/api/v1/properties/filters?page=4",
        "prev": "https://homzen.botble.com/api/v1/properties/filters?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 4,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/properties/filters?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/properties/filters?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/properties/filters?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/properties/filters?page=3",
                "label": "3",
                "page": 3,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/properties/filters?page=4",
                "label": "4",
                "page": 4,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/properties/filters",
        "per_page": 16,
        "to": null,
        "total": 61
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/properties/filters

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

type   string  optional  

Filter by property type (sale, rent). Example: architecto

city_id   string  optional  

Filter by city ID. Example: architecto

state_id   string  optional  

Filter by state ID. Example: architecto

country_id   integer  optional  

Filter by country ID. Example: 16

category_id   string  optional  

Filter by category ID. Example: architecto

project_id   string  optional  

Filter by project ID. Example: architecto

min_price   string  optional  

Filter by minimum price. Example: architecto

max_price   string  optional  

Filter by maximum price. Example: architecto

min_square   string  optional  

Filter by minimum square footage. Example: architecto

max_square   string  optional  

Filter by maximum square footage. Example: architecto

number_bedroom   integer  optional  

Filter by number of bedrooms. Example: 16

number_bathroom   integer  optional  

Filter by number of bathrooms. Example: 16

number_floor   integer  optional  

Filter by number of floors. Example: 16

features   string  optional  

Filter by feature IDs (comma-separated). Example: architecto

facilities   string  optional  

Filter by facility IDs (comma-separated). Example: architecto

is_featured   string  optional  

Filter by featured properties (1 or 0). Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: desc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: created_at. One of: created_at, updated_at, name, price Example: architecto

Get property by slug

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/properties/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/properties/architecto"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Property not found"
}

Request      

GET api/v1/properties/{slug}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

slug   string   

The slug of the property. Example: architecto

Get property by ID

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/properties/id/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/properties/id/16"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Property not found"
}

Request      

GET api/v1/properties/id/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the property. Example: 16

List projects

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/projects?page=16&per_page=16&search=architecto&city_id=architecto&state_id=architecto&country_id=16&category_id=architecto&investor_id=architecto&min_price=architecto&max_price=architecto&is_featured=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/projects"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "city_id": "architecto",
    "state_id": "architecto",
    "country_id": "16",
    "category_id": "architecto",
    "investor_id": "architecto",
    "min_price": "architecto",
    "max_price": "architecto",
    "is_featured": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/projects?page=1",
        "last": "https://homzen.botble.com/api/v1/projects?page=2",
        "prev": "https://homzen.botble.com/api/v1/projects?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 2,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/projects?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/projects?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/projects?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/projects",
        "per_page": 16,
        "to": null,
        "total": 18
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/projects

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

city_id   string  optional  

Filter by city ID. Example: architecto

state_id   string  optional  

Filter by state ID. Example: architecto

country_id   integer  optional  

Filter by country ID. Example: 16

category_id   string  optional  

Filter by category ID. Example: architecto

investor_id   string  optional  

Filter by investor ID. Example: architecto

min_price   string  optional  

Filter by minimum price. Example: architecto

max_price   string  optional  

Filter by maximum price. Example: architecto

is_featured   string  optional  

Filter by featured projects (1 or 0). Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: desc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: created_at. One of: created_at, updated_at, name, price_from Example: architecto

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/projects/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/projects/search"
);

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

let body = {
    "q": "architecto"
};

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

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}

Get project filters

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/projects/filters?page=16&per_page=16&search=architecto&city_id=architecto&state_id=architecto&country_id=16&category_id=architecto&investor_id=architecto&min_price=architecto&max_price=architecto&is_featured=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/projects/filters"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "city_id": "architecto",
    "state_id": "architecto",
    "country_id": "16",
    "category_id": "architecto",
    "investor_id": "architecto",
    "min_price": "architecto",
    "max_price": "architecto",
    "is_featured": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/projects/filters?page=1",
        "last": "https://homzen.botble.com/api/v1/projects/filters?page=2",
        "prev": "https://homzen.botble.com/api/v1/projects/filters?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 2,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/projects/filters?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/projects/filters?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/projects/filters?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/projects/filters",
        "per_page": 16,
        "to": null,
        "total": 18
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/projects/filters

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

city_id   string  optional  

Filter by city ID. Example: architecto

state_id   string  optional  

Filter by state ID. Example: architecto

country_id   integer  optional  

Filter by country ID. Example: 16

category_id   string  optional  

Filter by category ID. Example: architecto

investor_id   string  optional  

Filter by investor ID. Example: architecto

min_price   string  optional  

Filter by minimum price. Example: architecto

max_price   string  optional  

Filter by maximum price. Example: architecto

is_featured   string  optional  

Filter by featured projects (1 or 0). Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: desc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: created_at. One of: created_at, updated_at, name, price_from Example: architecto

Get project by slug

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/projects/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/projects/architecto"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Project not found"
}

Request      

GET api/v1/projects/{slug}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

slug   string   

The slug of the project. Example: architecto

Get project by ID

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/projects/id/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/projects/id/16"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Project not found"
}

Request      

GET api/v1/projects/id/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the project. Example: 16

Get properties of a project

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/projects/id/16/properties?page=16&per_page=16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/projects/id/16/properties"
);

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

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Project not found"
}

Request      

GET api/v1/projects/id/{id}/properties

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the project. Example: 16

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

Get category by ID

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/categories/id/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/categories/id/16"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Category not found"
}

Request      

GET api/v1/categories/id/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the category. Example: 16

Get properties of a category

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/categories/id/16/properties?page=16&per_page=16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/categories/id/16/properties"
);

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

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Category not found"
}

Request      

GET api/v1/categories/id/{id}/properties

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the category. Example: 16

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

List features

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/features?page=16&per_page=16&search=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/features"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/features?page=1",
        "last": "https://homzen.botble.com/api/v1/features?page=1",
        "prev": "https://homzen.botble.com/api/v1/features?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 1,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/features?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/features?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/features",
        "per_page": 16,
        "to": null,
        "total": 12
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/features

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: asc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: name. One of: created_at, updated_at, name Example: architecto

Get all features (without pagination)

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/features/all?search=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/features/all"
);

const params = {
    "search": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Wifi",
            "icon": "ti ti-wifi",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 2,
            "name": "Parking",
            "icon": "ti ti-parking",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 3,
            "name": "Swimming pool",
            "icon": "ti ti-pool",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 4,
            "name": "Balcony",
            "icon": "ti ti-building-skyscraper",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 5,
            "name": "Garden",
            "icon": "ti ti-trees",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 6,
            "name": "Security",
            "icon": "ti ti-shield-lock",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 7,
            "name": "Fitness center",
            "icon": "ti ti-stretching",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 8,
            "name": "Air Conditioning",
            "icon": "ti ti-air-conditioning",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 9,
            "name": "Central Heating",
            "icon": "ti ti-thermometer",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 10,
            "name": "Laundry Room",
            "icon": "ti ti-wash-machine",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 11,
            "name": "Pets Allow",
            "icon": "ti ti-paw",
            "status": "published",
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 12,
            "name": "Spa & Massage",
            "icon": "ti ti-bath",
            "status": "published",
            "created_at": null,
            "updated_at": null
        }
    ],
    "error": false,
    "message": null
}

Request      

GET api/v1/features/all

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Limit results to those matching a string. Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: asc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: name. One of: created_at, updated_at, name Example: architecto

Get feature by ID

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/features/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/features/16"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Feature not found"
}

Request      

GET api/v1/features/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the feature. Example: 16

List facilities

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/facilities?page=16&per_page=16&search=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/facilities"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/facilities?page=1",
        "last": "https://homzen.botble.com/api/v1/facilities?page=1",
        "prev": "https://homzen.botble.com/api/v1/facilities?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 1,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/facilities?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/facilities?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/facilities",
        "per_page": 16,
        "to": null,
        "total": 11
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/facilities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: asc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: name. One of: created_at, updated_at, name Example: architecto

Get all facilities (without pagination)

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/facilities/all?search=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/facilities/all"
);

const params = {
    "search": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Hospital",
            "icon": "ti ti-hospital",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 2,
            "name": "Super Market",
            "icon": "ti ti-shopping-cart",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 3,
            "name": "School",
            "icon": "ti ti-school",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 4,
            "name": "Entertainment",
            "icon": "ti ti-movie",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 5,
            "name": "Pharmacy",
            "icon": "ti ti-pill",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 6,
            "name": "Airport",
            "icon": "ti ti-plane-departure",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 7,
            "name": "Railways",
            "icon": "ti ti-train",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 8,
            "name": "Bus Stop",
            "icon": "ti ti-bus",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 9,
            "name": "Beach",
            "icon": "ti ti-beach",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 10,
            "name": "Mall",
            "icon": "ti ti-shopping-cart",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 11,
            "name": "Bank",
            "icon": "ti ti-building-bank",
            "status": {
                "value": "published",
                "label": "Published"
            },
            "created_at": null,
            "updated_at": null
        }
    ],
    "error": false,
    "message": null
}

Request      

GET api/v1/facilities/all

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Limit results to those matching a string. Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: asc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: name. One of: created_at, updated_at, name Example: architecto

Get facility by ID

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/facilities/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/facilities/16"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Facility not found"
}

Request      

GET api/v1/facilities/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the facility. Example: 16

List agents/accounts

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/agents?page=16&per_page=16&search=architecto&is_featured=architecto&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/agents"
);

const params = {
    "page": "16",
    "per_page": "16",
    "search": "architecto",
    "is_featured": "architecto",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/agents?page=1",
        "last": "https://homzen.botble.com/api/v1/agents?page=1",
        "prev": "https://homzen.botble.com/api/v1/agents?page=15",
        "next": null
    },
    "meta": {
        "current_page": 16,
        "from": null,
        "last_page": 1,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/agents?page=15",
                "label": "&laquo; Previous",
                "page": 15,
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/agents?page=1",
                "label": "1",
                "page": 1,
                "active": false
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/agents",
        "per_page": 16,
        "to": null,
        "total": 5
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/agents

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

search   string  optional  

Limit results to those matching a string. Example: architecto

is_featured   string  optional  

Filter by featured agents (1 or 0). Example: architecto

order   string  optional  

Order sort attribute ascending or descending. Default: desc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: created_at. One of: created_at, updated_at, first_name, last_name Example: architecto

Get account by ID

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/agents/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/agents/16"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Account not found"
}

Request      

GET api/v1/agents/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the account. Example: 16

Get properties of an account

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/agents/16/properties?page=16&per_page=16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/agents/16/properties"
);

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

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Account not found"
}

Request      

GET api/v1/agents/{id}/properties

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the account. Example: 16

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

Get projects of an account

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/agents/16/projects?page=16&per_page=16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/agents/16/projects"
);

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

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Account not found"
}

Request      

GET api/v1/agents/{id}/projects

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the account. Example: 16

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

List reviews for a property

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/properties/16/reviews?page=16&per_page=16&order=architecto&order_by=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/properties/16/reviews"
);

const params = {
    "page": "16",
    "per_page": "16",
    "order": "architecto",
    "order_by": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Property not found"
}

Request      

GET api/v1/properties/{property_id}/reviews

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

property_id   integer   

The ID of the property. Example: 16

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 16

per_page   integer  optional  

Maximum number of items to be returned in result set. Default: 10 Example: 16

order   string  optional  

Order sort attribute ascending or descending. Default: desc. One of: asc, desc Example: architecto

order_by   string  optional  

Sort collection by object attribute. Default: created_at. One of: created_at, updated_at, star Example: architecto

Get review by ID

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/reviews/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/reviews/16"
);

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

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

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Review not found"
}

Request      

GET api/v1/reviews/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the review. Example: 16

Send consultation request

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/consults" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"John Doe\",
    \"email\": \"[email protected]\",
    \"phone\": \"+1234567890\",
    \"content\": \"I\'m interested in this property.\",
    \"consult_custom_fields\": [
        \"architecto\"
    ],
    \"type\": \"property\",
    \"data_id\": 1
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/consults"
);

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

let body = {
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "content": "I'm interested in this property.",
    "consult_custom_fields": [
        "architecto"
    ],
    "type": "property",
    "data_id": 1
};

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

Request      

POST api/v1/consults

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of the person. Example: John Doe

email   string   

The email address. Example: [email protected]

phone   string  optional  

The phone number. Example: +1234567890

content   string   

The consultation message. Example: I'm interested in this property.

consult_custom_fields   string[]  optional  

Custom field values.
1   string  optional  

Must not be greater than 255 characters. Example: Custom field value 1

type   string   

The type of consultation (property or project). Example: property

data_id   integer   

The ID of the property or project. Example: 1

Get consultation custom fields

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/consults/custom-fields" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/consults/custom-fields"
);

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

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

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Schedule a Tour (optional)",
            "type": "date",
            "options": []
        }
    ],
    "error": false,
    "message": null
}

Request      

GET api/v1/consults/custom-fields

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Get account profile

requires authentication

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/account/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/account/profile"
);

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

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

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/account/profile

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Create a review for a property

requires authentication

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/properties/16/reviews" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reviewable_type\": \"Botble\\\\RealEstate\\\\Models\\\\Property\",
    \"star\": 5,
    \"content\": \"This is an excellent property with great amenities.\",
    \"comment\": \"Great property!\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/properties/16/reviews"
);

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

let body = {
    "reviewable_type": "Botble\\RealEstate\\Models\\Property",
    "star": 5,
    "content": "This is an excellent property with great amenities.",
    "comment": "Great property!"
};

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

Request      

POST api/v1/properties/{property_id}/reviews

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

property_id   integer   

The ID of the property. Example: 16

Body Parameters

reviewable_type   string  optional  

Type of reviewable entity (Property or Project). Example: Botble\RealEstate\Models\Property

Must be one of:
  • Botble\RealEstate\Models\Property
  • Botble\RealEstate\Models\Project
star   integer   

The rating (1-5). Example: 5

content   string   

Content of the review. Must be at least 4 characters. Must not be greater than 500 characters. Example: This is an excellent property with great amenities.

comment   string   

The review comment. Example: Great property!

Update a review

requires authentication

Example request:
curl --request PUT \
    "https://homzen.botble.com/api/v1/reviews/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reviewable_type\": \"Botble\\\\RealEstate\\\\Models\\\\Property\",
    \"star\": 5,
    \"content\": \"This is an excellent property with great amenities.\",
    \"comment\": \"Updated review!\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/reviews/16"
);

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

let body = {
    "reviewable_type": "Botble\\RealEstate\\Models\\Property",
    "star": 5,
    "content": "This is an excellent property with great amenities.",
    "comment": "Updated review!"
};

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

Request      

PUT api/v1/reviews/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the review. Example: 16

Body Parameters

reviewable_type   string  optional  

Type of reviewable entity (Property or Project). Example: Botble\RealEstate\Models\Property

Must be one of:
  • Botble\RealEstate\Models\Property
  • Botble\RealEstate\Models\Project
star   integer   

The rating (1-5). Example: 5

content   string   

Content of the review. Must be at least 4 characters. Must not be greater than 500 characters. Example: This is an excellent property with great amenities.

comment   string   

The review comment. Example: Updated review!

Delete a review

requires authentication

Example request:
curl --request DELETE \
    "https://homzen.botble.com/api/v1/reviews/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/reviews/16"
);

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

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

Request      

DELETE api/v1/reviews/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the review. Example: 16

Social Login

Apple login

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/auth/apple" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"identityToken\": \"architecto\",
    \"guard\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/auth/apple"
);

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

let body = {
    "identityToken": "architecto",
    "guard": "architecto"
};

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

Example response (200):


{
    "error": false,
    "data": {
        "token": "1|abc123def456...",
        "user": {
            "id": 1,
            "name": "John Doe",
            "email": "[email protected]"
        }
    },
    "message": "Login successful"
}

Example response (400):


{
    "error": true,
    "message": "Invalid Apple token"
}

Example response (400):


{
    "error": true,
    "message": "Cannot login, no email or Apple ID provided!"
}

Request      

POST api/v1/auth/apple

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

identityToken   string   

The Apple identity token received from Apple Sign-In. Example: architecto

guard   string  optional  

optional The guard to use for authentication (default: web). Example: architecto

Google login

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/auth/google" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"identityToken\": \"architecto\",
    \"guard\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/auth/google"
);

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

let body = {
    "identityToken": "architecto",
    "guard": "architecto"
};

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

Example response (200):


{
    "error": false,
    "data": {
        "token": "1|abc123def456...",
        "user": {
            "id": 1,
            "name": "John Doe",
            "email": "[email protected]"
        }
    },
    "message": "Login successful"
}

Example response (400):


{
    "error": true,
    "message": "Invalid Google token"
}

Example response (400):


{
    "error": true,
    "message": "Google authentication is not properly configured"
}

Request      

POST api/v1/auth/google

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

identityToken   string   

The Google identity token received from Google Sign-In. Example: architecto

guard   string  optional  

optional The guard to use for authentication (default: web). Example: architecto

Facebook login

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/auth/facebook" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"accessToken\": \"architecto\",
    \"guard\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/auth/facebook"
);

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

let body = {
    "accessToken": "architecto",
    "guard": "architecto"
};

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

Example response (200):


{
    "error": false,
    "data": {
        "token": "1|abc123def456...",
        "user": {
            "id": 1,
            "name": "John Doe",
            "email": "[email protected]"
        }
    },
    "message": "Login successful"
}

Example response (400):


{
    "error": true,
    "message": "Invalid Facebook token"
}

Example response (400):


{
    "error": true,
    "message": "Facebook authentication is not properly configured"
}

Request      

POST api/v1/auth/facebook

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

accessToken   string   

The Facebook access token received from Facebook Login. Example: architecto

guard   string  optional  

optional The guard to use for authentication (default: web). Example: architecto

X (Twitter) login

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/auth/x" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"accessToken\": \"architecto\",
    \"guard\": \"architecto\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/auth/x"
);

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

let body = {
    "accessToken": "architecto",
    "guard": "architecto"
};

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

Example response (200):


{
    "error": false,
    "data": {
        "token": "1|abc123def456...",
        "user": {
            "id": 1,
            "name": "John Doe",
            "email": "[email protected]"
        }
    },
    "message": "Login successful"
}

Example response (400):


{
    "error": true,
    "message": "Invalid X (Twitter) token"
}

Example response (400):


{
    "error": true,
    "message": "X (Twitter) authentication is not properly configured"
}

Request      

POST api/v1/auth/x

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

accessToken   string   

The X (Twitter) access token received from X OAuth. Example: architecto

guard   string  optional  

optional The guard to use for authentication (default: web). Example: architecto