> ## Documentation Index > Fetch the complete documentation index at: https://easybroker-staging.readme.io/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a property Returns the detailed information of a property linked to your integration # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "1.0", "title": "App Integration API", "description": "API for EasyBroker's partners. To get started click the Authorize button below and enter your API key." }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "https://api.stagingeb.com/v1/integration_partners", "description": "API URL" } ], "paths": { "/properties/{property_id}": { "parameters": [ { "$ref": "#/components/parameters/country_code" }, { "name": "property_id", "in": "path", "required": true, "description": "The public ID of the specified property.", "schema": { "type": "string" } } ], "get": { "tags": [ "Properties" ], "summary": "Retrieve a property", "description": "Returns the detailed information of a property linked to your integration", "responses": { "200": { "description": "Successful property request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/property_for_integration_not_found" } } } } }, "components": { "responses": { "property_for_integration_not_found": { "description": "The property doesn't exist in EasyBroker or for your integration.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "The property couldn't be found for your integration." } } } } } }, "UnauthorizedError": { "description": "API key is missing or invalid, or a restricted country was selected", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Your API key is invalid." } } } } } } }, "parameters": { "country_code": { "name": "Country-Code", "in": "header", "required": true, "description": "This header is mandatory and will be used to filter the resources", "schema": { "type": "string", "enum": [ "MX", "CL", "DO", "GT", "AR", "BR", "CO", "UY", "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AG", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CN", "CX", "CC", "KM", "CD", "CG", "CK", "CR", "CI", "CU", "CY", "CZ", "DK", "DJ", "DM", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FO", "FK", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HR", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "JM", "JP", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "ES", "LK", "SH", "KN", "LC", "PM", "VC", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "UM", "US", "UZ", "VU", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW" ], "example": "MX" } } }, "schemas": { "Property": { "properties": { "public_id": { "type": "string", "example": "EB-XXX123" }, "title": { "type": "string", "example": "Fitted kitchen with granite countertops" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "example": "https://www.easybroker.com/mx/inmueble/john-smith-amazing-house" }, "description": { "type": "string", "example": "This property is very well-lit in a lovely neighborhood overlooking a park.", "description": "The property listing description." }, "property_type": { "type": "string", "example": "Apartment" }, "bedrooms": { "type": "integer" }, "bathrooms": { "type": "integer" }, "half_bathrooms": { "type": "integer" }, "parking_spaces": { "type": "integer" }, "lot_size": { "type": "number", "description": "In square meters" }, "construction_size": { "type": "number", "description": "In square meters" }, "expenses": { "type": "string", "example": "5000", "description": "The monthly expenses of the property." }, "lot_length": { "type": "integer" }, "lot_width": { "type": "integer" }, "floors": { "nullable": true, "type": "integer", "example": 5, "description": "The number of floors in the building." }, "floor": { "nullable": true, "type": "integer", "example": 1, "description": "The floor number in which the property is located, useful for apartments. It can be set to a custom value such as 'Penthouse'" }, "age": { "type": "string", "example": "2020", "description": "One of \"under_construction\", \"new\" or the year the building was built" }, "agency_id": { "type": "string", "example": "1002" }, "agent_id": { "nullable": true, "type": "string", "example": "25-john" }, "ad_type": { "nullable": true, "type": "string", "example": "Featured" }, "location": { "$ref": "#/components/schemas/PropertyLocation" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyOperation" } }, "foreclosure": { "type": "boolean", "example": true, "description": "Indicates whether the property is up for auction. This option is available only to agencies in Mexico." }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyFeature" } }, "tags": { "type": "array", "example": [ "premium", "exclusive" ], "description": "Tags added by users as private information to classify properties, EasyBroker is not responsible for the content entered. Tags should only be use for filtering purposes, not listing display.", "items": { "type": "string" } }, "property_images": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyImage" }, "description": "Deprecated, you should use the \"images\" attribute instead.", "deprecated": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyImage" } }, "videos": { "type": "array", "items": { "type": "string", "example": "https://www.youtube.com/watch?v=zVRu7AktR48" } }, "virtual_tour": { "nullable": true, "type": "string", "example": "https://my.matterport.com/show/?m=yHsh2roFXnp" } } }, "PropertyLocation": { "properties": { "region": { "type": "string", "example": "Ciudad de México" }, "city": { "type": "string", "example": "Cuauhtémoc" }, "city_area": { "nullable": true, "type": "string", "example": "Condesa" }, "street": { "nullable": true, "type": "string", "example": "Benito Juárez" }, "postal_code": { "nullable": true, "type": "string", "example": "06700" }, "latitude": { "nullable": true, "type": "number", "example": 20.676145 }, "longitude": { "nullable": true, "type": "number", "example": -103.368962 }, "show_exact_location": { "type": "boolean", "example": true } } }, "PropertyOperation": { "oneOf": [ { "$ref": "#/components/schemas/PropertyOperationSaleOrRental" }, { "$ref": "#/components/schemas/PropertyOperationTemporaryRental" } ] }, "PropertyOperationSaleOrRental": { "required": [ "type", "currency", "unit" ], "properties": { "type": { "type": "string", "enum": [ "sale", "rental" ] }, "amount": { "type": "number", "format": "double", "example": 500000 }, "formatted_amount": { "type": "string", "example": "$500,000 USD" }, "currency": { "type": "string", "example": "USD" }, "unit": { "type": "string", "enum": [ "total", "square_meter", "hectare" ], "description": "Some properties, like warehouses, are sold and rented per square meter. Some terrains are rented per hectare." } } }, "PropertyOperationTemporaryRental": { "required": [ "type", "currency" ], "properties": { "type": { "type": "string", "example": "temporary_rental" }, "amount": { "type": "number", "format": "double", "example": 500 }, "formatted_amount": { "type": "string", "example": "$500 USD" }, "currency": { "type": "string", "example": "USD" }, "period": { "type": "string", "enum": [ "monthly", "weekly", "daily" ], "description": "Used for temporary rentals" } } }, "PropertyFeature": { "properties": { "id": { "type": "integer", "example": 324 }, "name": { "type": "string", "example": "Pets allowed" }, "name_es": { "type": "string", "example": "Mascotas permitidas" }, "name_pt": { "type": "string", "example": "Animais de estimação são permitidos" }, "country_id": { "type": "integer", "example": 150 } } }, "PropertyImage": { "properties": { "url": { "type": "string", "example": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg" }, "title": { "type": "string", "example": "Fitted kitchen with granite countertops" } } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Authorization", "description": "Keys for this API are only available for our partners." } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 99, "1": 137, "2": 61, "3": 110, "4": 171, "5": 138, "6": 160, "7": 0, "8": 29, "9": 31, "10": 125, "11": 97 } } } ```