← Home Get Countries

Get Countries

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

This endpoint lists countries to be used in create/update user 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, countri(es) with matching title would be returned.	United Arab Emirates
per_page	integer	Optional	The number of results per page.	10

Response Schema

Name	Type	Required	Description	Example
data	object	Optional	The resource representing a country with its currency and PayPal information.
id	integer	Optional	The unique identifier for the country.	1
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/countries?title=United%20Arab%20Emirates&per_page=10' \
--header 'Authorization: Bearer <token>'

{
    "data": [
        {
            "id": 1,
            "title": {
                "en": "Afghanistan",
                "ar": "أفغانستان"
            },
            "currency": null,
            "country_code": "AF"
        },
        {
            "id": 2,
            "title": {
                "en": "Albania",
                "ar": "ألبانيا"
            },
            "currency": null,
            "country_code": "AL"
        }
    ]
}