Quickstart Guide

Welcome to Bayut! This quickstart guide will help you get started with Bayut's Profolio API, allowing you to make your first API call and begin with property management.

Step 1: Get Your API Token

Visit the Profolio Sign-In Page and log in.
Navigate to your dashboard to retrieve your API token.

Your API token is required to authenticate all API requests.

Step 2: Retrieving a User

Let's start by making a simple request to the Profolio Users API to retrieve the user against which you want to add a property later.

Request

Use the following curl command to find user ID:

curl --location 'https://api.bayut.com/v1/users?agency_id=YOUR_BRANCH_ID' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

agency_id: The agency's branch ID you wish to select user from.

Response

{
    "data": [
        {
            "id": 1,
            "name": {
                "en": "Real Estate User",
                "ar": null
            },
            "contact": {
                "email": "user@realestate.com",
                "phone": +971-55-0000000,
                "cell": "+971-55-0000000",
                "whatsapp": "+971-55-0000000"
            },
            "role": "agency-owner",
            "agency": {
                "id": 1,
                "name": "Real Estate Agency"
            }
        }
    ],
    "links": {
        "first": "https://api.bayut.com/v1/users?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.bayut.com/v1/users",
        "per_page": 20,
        "to": 1,
        "total": 1
    }
}

This response sucessfully returns the list of users of selected agency branch. Pick the ID of the user to be used in create property API.

Step 3: Adding a property

Next, let's add a property using the property API.

Request

To post a new property, use this curl command:

curl --location 'https://api.bayut.com/v1/properties' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data '{
    "reference": "100020-hgY57jg3",
    "user_id": 1,
    "title": {
        "en": "Apartment for sale"
    },
    "description": {
        "en": "Agency is pleased to offer this three-bedroom apartment in Dubai Marina."
    },
    "area": 2634.1,
    "bedrooms": 3,
    "bathrooms": 2,
    "category": "apartments",
    "construction_status": "completed",
    "location_id": 10989,
    "ownership_status": "freehold",
    "purpose": "sale",
    "price": 790000,
    "images": [
        {
            "is_main": true,
            "path": "https://images.squarespace-cdn.com/content/v1/57a0dbf5b3db2b31eb5fd34c/8bffe50e-e11c-4e88-a511-ba5ad14c8fea/Bailey-home-remodling-middleton-wi-1-35.jpg?format=2500w",
            "title": "Main Living Area"
        }
    ],
    "portals": [
        "bayut"
    ]
    
}'

Field	Description	Example Value
`reference`	Any unique identifier for referencing your property reference.	`"PROP-12345"`
`user_id`	The specific user ID you retrieved in the step above.	`9876`
`title`	The title of the property.	`"Luxury 2-Bedroom Apartment in Downtown"`
`description`	The description of the property.	`"Spacious apartment with modern design and city view."`
`area`	The area of the property.	`1500`
`category`	The category of the property.	`"apartment"`
`construction_status`	The construction status of the property.	`"ready"`
`location_id`	The specific location ID of your property. ID can be retrieved by searching location using Location API.	`34567`
`ownership_status`	The ownership status of the property.	`"freehold"`
`purpose`	The purpose of the property (e.g., sale or rent).	`"sale"`
`price`	The sale or rent price of the property.	`2500000`
`images`	The images of the property.	`["https://example.com/image1.jpg", "https://example.com/image2.jpg"]`
`portals`	The portal where you want to upload the property (e.g., Bayut, Dubizzle).	`["bayut", "dubizzle"]`

Response

{
    "message": "Property created successfully",
    "data": {
        "id": 1111111,
        "reference": "100020-hgY57jg3",
        "title": {
            "en": "Apartment for sale",
            "ar": ""
        },
        "description": {
            "en": "Agency is pleased to offer this three-bedroom apartment in Dubai Marina.",
            "ar": ""
        },
        "bedrooms": 3,
        "bathrooms": 2,
        "area": 2634.1,
        "area_unit": "sqft",
        "price": 790000,
        "purpose": {
            "en": "For Sale",
            "ar": "للبیع"
        },
        "category": {
            "id": 4,
            "title": {
                "en": "Apartments",
                "ar": "شقة"
            },
            "parent_title": "Residential"
        },
        "sale_details": {
            "financing_available": null,
            "financing_institute": null
        },
        "furnishing_status": null,
        "completion_status": "completed",
        "completion_date": null,
        "comment": null,
        "verification_state": null,
        "permit": {
            "number": null,
            "status": null
        },
        "location": {
            "id": 10989,
            "title": {
                "en": "Swiss Belhotel Sharjah",
                "ar": "فندق سويس بلهوتل الشارقة"
            },
            ...
        },
        "user_detail": {
            "id": 1,
            "name": {
                "en": "Jane  Doe",
                "ar": "جاين"
            },
            ...
        },
        "created_at": "2025-10-19T14:33:29.000000Z",
        "updated_at": "2025-10-19T14:33:29.000000Z"
    }
}

This response confirms that you have successfully added a property on specific user's behalf.

Step 4: Retrieving Property Detail

You may want to retrieve details and status of specific property. Here's how to do that:

Request

Use the following curl command to retrieve a property:

curl --location 'https://api.bayut.com/v1/properties/1111111' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Response

{
    "data": {
        "id": 1111111,
        "reference": "100020-hgY57jg4",
        "title": {
            "en": "Apartment for sale",
            "ar": ""
        },
        "description": {
            "en": "Agency is pleased to offer this three-bedroom apartment in Dubai Marina.",
            "ar": ""
        },
        "bedrooms": 3,
        "bathrooms": 2,
        "area": 2634.1,
        "area_unit": "sqft",
        "price": 790000,
        "purpose": {
            "en": "For Sale",
            "ar": "للبیع"
        },
        "category": {
            "id": 4,
            "title": {
                "en": "Apartments",
                "ar": "شقة"
            },
            "parent_title": "Residential"
        },
        "sale_details": {
            "financing_available": null,
            "financing_institute": null
        },
        "furnishing_status": null,
        "completion_status": "completed",
        "completion_date": null,
        "offplan_details": {
            "sale_type": null,
            "dld_waiver": null,
            "original_price": null,
            "amount_paid": null
        },
        "comment": null,
        "verification_state": null,
        "permit": {
            "number": null,
            "status": null
        },
        "location": {
            "id": 10989,
            "title": {
                "en": "Swiss Belhotel Sharjah",
                "ar": "فندق سويس بلهوتل الشارقة"
            },
            ...
        },
        "images": [
            {
                "url": "https://assets.bayut.com/listing-images/SwEvxvDVvP3plqUWPM2bqddl3bM8jpIvedLrJVUg",
                "is_main": true
            }
        ],
        "videos": [],
        "portals": [
            {
                "id": 1,
                "name": "bayut",
                "state": "active",
                "published_at": "2025-10-19T14:37:00.000000Z",
                "refreshed_at": "2025-10-19T14:37:00.000000Z",
                "ad_products": []
            },
            {
                "id": 2,
                "name": "dubizzle",
                "state": "draft",
                "published_at": null,
                "refreshed_at": null,
                "ad_products": {}
            }
        ],
        "amenities": [],
        "user_detail": {
            "id": 1,
            "name": {
                "en": "Jane  Doe",
                "ar": "جاين"
            },
            ...
        },
        "created_at": "2025-10-19T14:37:00.000000Z",
        "updated_at": "2025-10-19T14:37:00.000000Z"
    }
}

This response indicates that the property has been successfully retrieved and data.portals.state shows that the property is active on bayut but draft on dubizzle portal.

Congratulations!

You’ve successfully posted property using the Profolio API! Explore more features in our documentation.

On this page