← Home Get Amenities

Get Amenitites

GEThttps://api.bayut.com/v1/amenities

The endpoint lists all the amenities to be used in create/update properties endpoints.

🔐 Bearer Token: Provide your bearer token in the Authorization header when making requests to protected resources.

Query Parameters

Name	Type	Required	Description	Example
title	string	Optional	The title filter, ameniti(es) with matching title would be returned.	Heating

Response Schema

Name	Type	Required	Description	Example
data	object	Optional	Represents an amenity or feature associated with a property.
id	integer	Optional	Unique identifier for the amenity.	12
externalTitle	object	Optional
type	string	Optional	Type of amenity (e.g., 'boolean', 'select', 'number', etc.).	boolean
index	integer	Optional	Internal index/order for display grouping or categorization.	1
options	array[object]	Optional
portals	array	Optional	List of portals that support or display this amenity.
defaultValue	string	Optional
purpose	string	Optional
slug	string	Optional	Slugified version of the amenity title used for internal referencing.	swimming-pool
categories	array	Optional	Categories associated with this amenity.
externalTooltip	object	Optional
displayOrder	integer	Optional
links	object	Optional	The links to pages.
first	string	Optional	The link to first page.
last	string	Optional	The link to last page.
prev	string	Optional	The link to previous page.
next	string	Optional	The link to next page.
meta	object	Optional	Meta about pagination data.
current_page	integer	Optional	The page you are currently on.
from	integer	Optional	The first page of the paginated results.
path	string	Optional	The path of the current page.
per_page	integer	Optional	The number of results displayed per page.
to	integer	Optional	The last page of the paginated results.
total	integer	Optional	The total number of results.

Responses

200✅

401⚠️

403⚠️

Code Examples

curl --location 'https://api.bayut.com/v1/amenities' \
--header 'Authorization: Bearer <token>'

{
    "data": [
        {
            "id": 4,
            "title": {
                "en": "Barbeque Area",
                "ar": "مكان مخصص للشواء"
            },
            "slug": "barbeque-area",
            "group": {
                "en": "Recreation and Family",
                "ar": "الترفيه والأسرة"
            }
        }
    ]
}