Bayut API

POST https://cotlet.dev/api/v1/bayut/list_listings

Lists your listings as Manage Listings shows them, for Bayut or for dubizzle. Each item carries the quality score colour, the Checked and TruCheck badges and whether a floor plan is waiting to be assigned. Pages hold up to 100 listings; pass next_cursor back as cursor for the next page.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/list_listings \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"bayut","limit":100}'

result = client.call("bayut", "list_listings", {"platform":"bayut","limit":100})

const result = await cotlet.call('bayut', 'list_listings', {"platform":"bayut","limit":100});

cotlet call bayut list_listings --data '{"platform":"bayut","limit":100}'

Example response

{
  "listings": [
    {
      "listing_id": "DM-2214",
      "platform": "bayut",
      "title": "2BR in Dubai Marina, marina view",
      "quality_score": "orange",
      "badges": [
        "checked"
      ],
      "floor_plan_waiting": true
    },
    {
      "listing_id": "DM-2290",
      "platform": "bayut",
      "title": "Studio in JLT, furnished",
      "quality_score": "green",
      "badges": [
        "checked"
      ],
      "floor_plan_waiting": false
    }
  ],
  "next_cursor": null
}

POST https://cotlet.dev/api/v1/bayut/get_listing

Returns one listing with its price, purpose, photos, assigned floor plan, quality score and the badges it has today. Use it to check whether a TruCheck request went through. Read only.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/get_listing \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"listing_8c41d2"}'

result = client.call("bayut", "get_listing", {"listing_id":"listing_8c41d2"})

const result = await cotlet.call('bayut', 'get_listing', {"listing_id":"listing_8c41d2"});

cotlet call bayut get_listing --data '{"listing_id":"listing_8c41d2"}'

Example response

{
  "listing_id": "DM-2290",
  "platform": "bayut",
  "title": "Studio in JLT, furnished",
  "purpose": "rent",
  "price_aed": 62000,
  "photos": 14,
  "floor_plan": "assigned",
  "quality_score": "green",
  "badges": [
    "checked"
  ]
}

POST https://cotlet.dev/api/v1/bayut/get_listing_insights

Returns impressions, clicks and leads for each listing, as Listing Insights shows them for Bayut. Low performing means a lower click-through rate than similar listings on Bayut. Filters combine, and the listing ID filter accepts your reference number.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/get_listing_insights \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"low_performing_only":true,"purpose":"rent","location":"Jumeirah Lake Towers"}'

result = client.call("bayut", "get_listing_insights", {"low_performing_only":True,"purpose":"rent","location":"Jumeirah Lake Towers"})

const result = await cotlet.call('bayut', 'get_listing_insights', {"low_performing_only":true,"purpose":"rent","location":"Jumeirah Lake Towers"});

cotlet call bayut get_listing_insights --data '{"low_performing_only":true,"purpose":"rent","location":"Jumeirah Lake Towers"}'

Example response

{
  "listings": [
    {
      "listing_id": "DM-2214",
      "location": "Dubai Marina",
      "purpose": "sale",
      "impressions": 1840,
      "clicks": 21,
      "leads": 1,
      "low_performing": true
    },
    {
      "listing_id": "DM-2290",
      "location": "JLT",
      "purpose": "rent",
      "impressions": 960,
      "clicks": 40,
      "leads": 3,
      "low_performing": false
    }
  ],
  "next_cursor": null
}

POST https://cotlet.dev/api/v1/bayut/list_leads

Lists leads from all five channels Profolio reports: email, sms, phone, whatsapp and chat. Each lead names the listing of interest and the time it arrived. Pass lead_id to get_lead for the contact details. Pages hold up to 100 leads.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/list_leads \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"since":"2026-10-11T04:00:00Z","limit":100}'

result = client.call("bayut", "list_leads", {"since":"2026-10-11T04:00:00Z","limit":100})

const result = await cotlet.call('bayut', 'list_leads', {"since":"2026-10-11T04:00:00Z","limit":100});

cotlet call bayut list_leads --data '{"since":"2026-10-11T04:00:00Z","limit":100}'

Example response

{
  "leads": [
    {
      "lead_id": "ld_40a1",
      "channel": "whatsapp",
      "listing_id": "DM-2214",
      "received_at": "2026-10-10T14:22:00Z"
    },
    {
      "lead_id": "ld_40a7",
      "channel": "whatsapp",
      "listing_id": "DM-2290",
      "received_at": "2026-10-10T18:05:00Z"
    }
  ],
  "next_cursor": null
}

POST https://cotlet.dev/api/v1/bayut/get_lead

Returns one lead. What it holds depends on the channel: the email address for email leads, the enquiry text for SMS leads, the phone number and the call recording for phone leads, and the message. Read only.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/get_lead \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lead_id":"lead_8c41d2"}'

result = client.call("bayut", "get_lead", {"lead_id":"lead_8c41d2"})

const result = await cotlet.call('bayut', 'get_lead', {"lead_id":"lead_8c41d2"});

cotlet call bayut get_lead --data '{"lead_id":"lead_8c41d2"}'

Example response

{
  "lead_id": "ld_40a1",
  "channel": "whatsapp",
  "listing_id": "DM-2214",
  "name": "Sample Buyer",
  "phone": "+971500000000",
  "message": "Is the unit still available for viewing this week?",
  "received_at": "2026-10-10T14:22:00Z"
}

POST https://cotlet.dev/api/v1/bayut/export_leads

Runs the export option at the top right of Reports, Leads and returns the Excel file as a download link. Pass a channel to export one channel only. Read only: nothing in Profolio changes.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/export_leads \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("bayut", "export_leads")

const result = await cotlet.call('bayut', 'export_leads');

cotlet call bayut export_leads

Example response

{
  "channel": "whatsapp",
  "file": "bayut-leads.xlsx",
  "download_url": "https://files.cotlet.example/exports/bayut-leads.xlsx",
  "rows": 2
}

POST https://cotlet.dev/api/v1/bayut/get_traffic_report

Returns the Traffic report from Reports: the top locations by impressions and the overall performance of your listings, for Bayut and dubizzle. Read only.

Parameters

No parameters.

Request

curl -X POST https://cotlet.dev/api/v1/bayut/get_traffic_report \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("bayut", "get_traffic_report")

const result = await cotlet.call('bayut', 'get_traffic_report');

cotlet call bayut get_traffic_report

Example response

{
  "top_locations": [
    {
      "location": "Dubai Marina",
      "impressions": 5210
    },
    {
      "location": "JLT",
      "impressions": 3180
    }
  ],
  "overall": {
    "impressions": 8390,
    "clicks": 144,
    "leads": 11
  }
}

POST https://cotlet.dev/api/v1/bayut/get_credits

Returns the Bayut Credits balance shown in Manage Listings. Read only.

Parameters

No parameters.

Request

curl -X POST https://cotlet.dev/api/v1/bayut/get_credits \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("bayut", "get_credits")

const result = await cotlet.call('bayut', 'get_credits');

cotlet call bayut get_credits

Example response

{
  "bayut_credits": 120
}

POST https://cotlet.dev/api/v1/bayut/get_market_insights

Returns Market Insights for Dubai or Abu Dhabi: the most searched communities, sub-communities and buildings, the average rent and sale prices, and the areas with the highest ROI. Read only.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/get_market_insights \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"city":"dubai"}'

result = client.call("bayut", "get_market_insights", {"city":"dubai"})

const result = await cotlet.call('bayut', 'get_market_insights', {"city":"dubai"});

cotlet call bayut get_market_insights --data '{"city":"dubai"}'

Example response

{
  "city": "dubai",
  "most_searched": [
    {
      "community": "Dubai Marina",
      "type": "community"
    },
    {
      "community": "Business Bay",
      "type": "community"
    }
  ],
  "average_prices_aed": {
    "rent": 118000,
    "sale": 1950000
  },
  "highest_roi": [
    {
      "community": "Jumeirah Village Circle",
      "roi_percent": 7.4
    }
  ]
}

POST https://cotlet.dev/api/v1/bayut/get_transactions

Returns last sold transaction data from the Dubai Land Department, as BayutPro shows it in Transactions. Only agencies registered in Dubai have this section. Filter by location, transaction type, time period, property type and bedrooms. Read only.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/get_transactions \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("bayut", "get_transactions")

const result = await cotlet.call('bayut', 'get_transactions');

cotlet call bayut get_transactions

Example response

{
  "transactions": [
    {
      "location": "Dubai Marina",
      "property_type": "apartment",
      "bedrooms": 2,
      "price_aed": 2150000,
      "date": "2026-09-28"
    }
  ],
  "next_cursor": null
}

POST https://cotlet.dev/api/v1/bayut/assign_floor_plan

Assigns a floor plan from the uploads section to one listing, the same step as clicking the floor plan icon in Profolio. The icon turns green once the plan is linked, and Bayut requires a floor plan for a perfect quality score. The floor plan becomes visible on the live listing. By default you confirm each call; you can switch that off for this tool.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/assign_floor_plan \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"DM-2214","floor_plan_id":"fp_3302"}'

result = client.call("bayut", "assign_floor_plan", {"listing_id":"DM-2214","floor_plan_id":"fp_3302"})

const result = await cotlet.call('bayut', 'assign_floor_plan', {"listing_id":"DM-2214","floor_plan_id":"fp_3302"});

cotlet call bayut assign_floor_plan --data '{"listing_id":"DM-2214","floor_plan_id":"fp_3302"}'

Example response

{
  "listing_id": "DM-2214",
  "floor_plan_id": "fp_3302",
  "status": "assigned"
}

POST https://cotlet.dev/api/v1/bayut/request_trucheck

Uploads up to 5 photos of a Checked property and submits them to request TruCheck validation, as the multiple photo upload in BayutPro does. Bayut recommends clear photos that show the unit number and an inside view. Bayut's moderation team reviews the submission, so the call returns "submitted"; check the badge later with get_listing. By default you confirm each call; you can switch that off for this tool.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/request_trucheck \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"listing_8c41d2","photo_urls":["https://example.com"]}'

result = client.call("bayut", "request_trucheck", {"listing_id":"listing_8c41d2","photo_urls":["https://example.com"]})

const result = await cotlet.call('bayut', 'request_trucheck', {"listing_id":"listing_8c41d2","photo_urls":["https://example.com"]});

cotlet call bayut request_trucheck --data '{"listing_id":"listing_8c41d2","photo_urls":["https://example.com"]}'

Example response

{
  "listing_id": "DM-2290",
  "photos": 2,
  "status": "submitted"
}

POST https://cotlet.dev/api/v1/bayut/apply_boost

Applies one boost product to one listing, as the boost products in Profolio do. Bayut offers Signature, Hot and Property of the Week; dubizzle offers Refresh and Featured. Check get_credits first. By default you confirm each call; you can switch that off for this tool.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/bayut/apply_boost \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"listing_8c41d2","product":"signature"}'

result = client.call("bayut", "apply_boost", {"listing_id":"listing_8c41d2","product":"signature"})

const result = await cotlet.call('bayut', 'apply_boost', {"listing_id":"listing_8c41d2","product":"signature"});

cotlet call bayut apply_boost --data '{"listing_id":"listing_8c41d2","product":"signature"}'

Example response

{
  "listing_id": "DM-2214",
  "platform": "bayut",
  "product": "hot",
  "status": "applied"
}