← Home Get Users

Get Users

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

This endpoint lists all the users.

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

Query Parameters

Name	Type	Required	Description	Example
per_page	string	Optional	The number of results per page.	2
role	string	Optional	The role filter, returns users with matching role.	agent
agency_id	integer	Optional	The agency filter, returns users with matching agency.	102917
email	string	Optional	The email filter, returns user with matching email.	john.doe@gmail.com
Accept	string	Optional		application/json

Response Schema

Name	Type	Required	Description
data	object	Optional	The data returned by the API.
id	integer	Optional	The ID of the user.
name	object	Optional	The name of the user.
about	string	Optional	The description of the user.
gender	string	Optional	The gender of the user.
image	string	Optional	The URL pointing to the User's profile picture.
experience_in_years	string	Optional
country	object	Optional	The information about User's country.
brn_number	string	Optional	The Broker Registration Number (BRN) of the user.
bln_number	string	Optional	The Broker License Number (BLN) of the user.
contact	object	Optional	The contact information of the user.
agency	object	Optional	The Agency of the user.
teams	array[string]	Optional	The teams of the user.
languages	array[integer]	Optional
social_medias	array[integer]	Optional
specialities	array[integer]	Optional
speciality_areas	array[object]	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.
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/users' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

{
    "data": [
        {
            "data": {
                "id": 2318195,
                "name": {
                    "en": "John Doe",
                    "ar": null
                },
                "about": "Real Estate Agent",
                "gender": "male",
                "image": "https://assets.stage.bayut.com/agents/Z1tXgUduNDPDQ1mWF2O6ToZKXtQ7M6gDSWx8ib7S",
                "experience_in_years": "5",
                "country": {
                    "en": "Antarctica",
                    "ar": "أنتاركتيكا"
                },
                "brn_number": "89238912839112",
                "bln_number": null,
                "contact": {
                    "email": "john.doe@gmail.com",
                    "phone": "+97141234567",
                    "cell": "+971501234567",
                    "whatsapp": null
                },
                "role": "agency-admin",
                "agency": {
                    "id": 102917,
                    "name": "Lake City Real Estate"
                },
                "teams": [],
                "languages": [
                    "English",
                    "Tamil"
                ],
                "social_medias": [],
                "specialities": [
                    "Off-Plan Sales",
                    "Residential Sales"
                ],
                "speciality_areas": [
                    {
                        "en": "Dubai",
                        "ar": "دبي"
                    },
                    {
                        "en": "Abu Dhabi",
                        "ar": "أبوظبي"
                    }
                ]
            }
        },
        {
            "data": {
                "id": 2318195,
                "name": {
                    "en": "Jane Doe",
                    "ar": "جين دو"
                },
                "about": "Real Estate Agent",
                "gender": "female",
                "image": "https://assets.stage.bayut.com/agents/Z1tXgUduNDPDQ1mWF2O6ToZKXtQ7M6gDSWx8ib7S",
                "experience_in_years": "5",
                "country": {
                    "en": "Antarctica",
                    "ar": "أنتاركتيكا"
                },
                "brn_number": "89238912839112",
                "bln_number": null,
                "contact": {
                    "email": "jane.doe@gmail.com",
                    "phone": "+97141234567",
                    "cell": "+971501234567",
                    "whatsapp": null
                },
                "role": "agency-admin",
                "agency": {
                    "id": 102917,
                    "name": "Lake City Real Estate"
                },
                "teams": [],
                "languages": [
                    "English",
                    "Tamil"
                ],
                "social_medias": [],
                "specialities": [
                    "Off-Plan Sales",
                    "Residential Sales"
                ],
                "speciality_areas": [
                    {
                        "en": "Dubai Marina",
                        "ar": "دبي"
                    },
                    {
                        "en": "Abu Dhabi",
                        "ar": "أبوظبي"
                    }
                ]
            }
        }
    ],
    "links": {
        "first": "https://api.bayut.com/v1/users?page=1",
        "last": null,
        "prev": null,
        "next": "https://api.bayut.com/v1/users?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.bayut.com/v1/users",
        "per_page": "2",
        "to": 2,
        "total": 190
    }
}