{"info":{"_postman_id":"8927220b-2631-4058-9ccf-cf2eaaee4173","name":"RE/MAX EU - Listings API","description":"

The Listings API is used in conjunction with the RE/MAX EU Datahub application to add, update and get listing data.

\n

Users can interact with the API using REST (GET, POST, PUT, DELETE) requests to the API URL.

\n

OAuth 2.0 Authentication

\n

The user makes a request for an API token using the OAuth 2.0 server. The access_key is then added as the access_token query parameter.

\n

Data Return Format

\n

In general, all requests have the following reponse format:

\n
{\n  \"success\": false | true,\n  \"message\": <Descriptive message>,\n  \"result\": {},// any data is returned here\n  \"error\": { // if success is false, an error will be returned here\n    \"error\": \"Invalid region action requested: the user does not have access to this region\"\n  },\n  \"status\": { \n    \"code\": 403, // http response code\n    \"message\": \"Forbidden\" // http response message\n  }\n}\n\n
\n

The only exceptions are:

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29687718","collectionId":"8927220b-2631-4058-9ccf-cf2eaaee4173","publishedId":"2sA3drJF17","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-01T07:26:16.000Z"},"item":[{"name":"Calls with Datahub IDs","item":[{"name":"Add Listing","id":"c1b53238-462c-46ff-ad5d-6dea16d61193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"listingId\" : \"test-12345\", // ID from your system for later reference\n \"status\": \"Active\",\n \"agentUniqueId\": \"CH2-P100002\",\n \"title\": \"Sample Title 2\",\n \"description\": \"Sample Description 2\",\n \"roomDescription\" : \"Sample room description\",\n \"bathroomDescription\" : \"Sample bathroom description\",\n \"bedroomDescription\" : \"Sample bedroom description\",\n \"kitchenDescription\" : \"Sample kitchen description\",\n \"address\": \"1234 Sample Street\",\n \"streetBlock\": \"Block 4\",\n \"zipcode\": \"12345\",\n \"regionId\": \"FI1\",\n \"officeId\":\"FI1-F1079993\",\n \"city\": \"Friesneksor\",\n \"country\": \"Finland\",\n \"offerType\": \"Sale\",\n \"listingType\": \"Commercial\",\n \"buildingSize\": 1000.00,\n \"propertySize\": 2000.00,\n \"sizeUnit\": \"m2\",\n \"virtualTour\": \"No\",\n \"noOfRooms\": 5,\n \"noOfBathrooms\": 2,\n \"noOfBedrooms\" : 2,\n \"constructionYear\": 2000,\n \"energyRating\": \"A\",\n \"floorNumber\": \"1\",\n \"elevatorAccess\": \"Yes\",\n \"outsideAreaType\": \"Garden\",\n \"outsideAreaSize\": \"Large\",\n \"listingCurrency\": \"EUR\",\n \"listingPrice\": 1000000.00,\n \"sellPrice\": 950000.00,\n \"dateSold\": \"2022-01-01T00:00:00Z\",\n \"datePublished\": \"2022-01-01T00:00:00Z\",\n \"commissionRateBuyer\": 3.00,\n \"commissionRateSeller\": 3.00,\n \"contractType\": \"Open\",\n \"buyerDemographic\": \"80+\",\n \"sellerDemographic\": \"80+\",\n \"listingUrl\" : \"test@test.com\",\n \"listingImages\" : [\n {\n \"webLink\" : \"test.image1.com\",\n \"description\" : \"Bathroom 1\"\n },\n {\n \"webLink\" : \"test.image2.com\",\n \"description\" : \"Bathroom 2\"\n }\n ]\n \n}","options":{"raw":{"language":"json"}}},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings?access_token=01b9f5f4dc9b53213140e641910c767a52fb77850a1a4d1fa84bde8433ade8994f7fafe25bbcbf8a236c614f45052204ec23043d15aee3d6ece56020e6943811","description":"

This request is used to add listings to the Listings API. The API uses a queueing system, and some validation is done in the queue. If the validation fails (on agent for example), the record is still added to the database, but a flag is set to indicate some validation has failed.

\n

The body, as per the sample below, contain certain required fields:

\n
\"listingId\" : \"test-123\", // unique identifier for listing (required)\n\"status\": \"Active\",   // can be 'Inactive', 'Active', 'Expired', 'Sold', 'Sale Agreed', 'Cancelled' (required)\n\"agentUniqueId\": \"AT-P100009\", // this is the unique agent Id from Datahub (required)\n\"title\": \"Sample Title 2\", // text title \n\"description\": \"Sample Description 2\", // text description (required)\n\"roomDescription\" : \"Sample room description\", // text (optional)\n\"bedroomDescription\" : \"Sample bedroom description\", // text (optional)\n\"bathroomDesctiption\" : \"Sample bathroom description\", // text (optional)\n\"kitchenDescription\" : \"Sample kitchen description\", // text (optional)\n\"address\": \"1234 Sample Street\", // address required\n\"streetBlock\": \"Block 4\", // street block (optional)\n\"zipcode\": \"12345\", // zipcode (required)\n\"regionId\": \"AT1\", // datahub regionId (required)\n\"officeId\":\"AT1-F1079993\", // datahub officeId (required)\n\"city\": \"Vienna2\", // city name (required)\n\"country\": \"Austria\", // country name (required)\n\"offerType\": \"Sale\", // can be 'Sale' or 'Rental' (required)\n\"listingType\": \"Commercial\", // can be 'Commercial' or 'Residential'\n\"propertyType\" : \"Villa\" , // text field (optional)\n// either buildingSize or propertySize must be passed, but both can also be passed\n\"buildingSize\": 1000.00,  // number, building size (optional)\n\"propertySize\": 2000.00,  // number, property size (optional)\n\"sizeUnit\": \"m2\",    // size unit of buildingSize and propertySize (required)\n\"virtualTour\": \"No\", // string value (required)\n\"noOfRooms\": 5, // number (optoonal)\n\"noOfBathrooms\": 2, // number (optional)\n\"noOfBedrooms\" : 3, // number (optional)\n\"constructionYear\": 2000, // construction year (required)\n\"energyRating\": \"A\", // energy rating (required)\n\"floorNumber\": \"1\",  // floor number, (required)\n\"elevatorAccess\": \"Yes\", // string value (optional, can also be null, or left out)\n\"outsideAreaType\": \"Garden\", // optional \n\"outsideAreaSize\": \"Large\", // optional\n\"listingPrice\": 1000000.00, // number value (required)\n\"listingCurrency\":  \"eur\", // Currency ISO\n\"sellPrice\": 950000.00, // sell price (optional)\n\"dateSold\": \"2022-01-01T00:00:00Z\", // optional value\n\"datePublished\": \"2022-01-01T00:00:00Z\", // required\n\"listingUrl\" : \"https://listing.com/1234\", // required\n\"commissionRateBuyer\": 3.00, // optional\n\"commissionRateSeller\": 3.00, // optional\n\"contractType\": \"Open\", // can be 'Open', 'Exclusive', 'Excluded for Cooperation' (required)\n\"buyerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"sellerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"listingImages\" : [ //images are optional\n  {\n    \"webLink\" : \"test.image1.com\", // this is required if image is passed\n    \"description\" : \"Bathroom 1\" // this is required if image is passed\n    \"isPrimary\": true // this will use the image as the cover image for the listing\n  },\n  {\n     \"webLink\" : \"test.image2.com\", // this is required if image is passed\n     \"description\" : \"Bathroom 2\" // this is required if image is passed\n     \"isPrimary\": false\n   }\n],\n\"agentImage\" : \n {\n    \"webLink\" : \"test.image1.com\",\n    \"description\" : \"Agent Image Test\",\n    \"isPrimary\" : true\n }\n\n
\n

The listing will be added to the queuing system: three parameters are passed that cannot be validated asynchronously:

\n\n

The application searches for a valid agent, region and office using the passed values. If an agent, region or office cannot be found in the RE/MAX EU Datahub database, a 'null' value is saved for agent, region or office and the appropriate flag is set: agentMatched is set if the agent is found, officeMatched is set if the office is found, regionMatched is set if the region is found.

\n","urlObject":{"protocol":"https","path":["api","v1","listings"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":"01b9f5f4dc9b53213140e641910c767a52fb77850a1a4d1fa84bde8433ade8994f7fafe25bbcbf8a236c614f45052204ec23043d15aee3d6ece56020e6943811"}],"variable":[]}},"response":[],"_postman_id":"c1b53238-462c-46ff-ad5d-6dea16d61193"},{"name":"Add Listing With Images","id":"2feb260d-1a30-4cfa-abd7-445704d0e45c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"listingId","value":"test-123","description":"

Unique identifier for listing (required)

\n","type":"text","uuid":"1c2e059f-d4b0-4c83-8191-405161aada69"},{"key":"agentUniqueId","value":"CH1-P10002","description":"

Required

\n","type":"text","uuid":"0f32f420-bafb-4f1d-946b-a5cbd99a2135"},{"key":"status","value":"Active","description":"

'Inactive', 'Active', 'Expired', 'Sold', 'Sale Agreed', 'Cancelled' (required)

\n","type":"text","uuid":"c6246804-35f6-4bf0-bbb6-c9ce83ff7eb6"},{"key":"title","value":"Listing Title","type":"text","uuid":"b0dfccb8-4210-4339-b866-8123d53a68fe"},{"key":"description","value":"Listing Description","type":"text","uuid":"df6c1d5a-d766-4d0a-b95d-075f2a0ea0b0"},{"key":"roomDescription","value":"Room description text","description":"

Optional

\n","type":"text","uuid":"34121f6f-dfa1-4508-802b-60ee982337e1"},{"key":"bedroomDescription","value":"Bedroom description text","description":"

Optional

\n","type":"text","uuid":"e99ffb43-f82b-4cf1-8031-12502e42eae9"},{"key":"bathroomDescription","value":"Bathroom description text","description":"

Optional

\n","type":"text","uuid":"fba7db8a-8c2e-4ed4-8b10-b330f8080a58"},{"key":"kitchenDescription","value":"Kitchen description text","description":"

Optional

\n","type":"text","uuid":"22f3dff7-b259-4301-97c9-1592ba8eb3bd"},{"key":"address","value":"1 Church Street","description":"

Required

\n","type":"text","uuid":"edac5335-e126-4dc3-b25a-bfeda3a9d2d2"},{"key":"streetBlock","value":"Block 4","description":"

Optional

\n","type":"text","uuid":"734dd8fa-642a-4db6-b1aa-c177c3bdd58b"},{"key":"zipcode","value":"1234","description":"

Required

\n","type":"text","uuid":"69a6faef-92a8-426e-a919-094b127565a9"},{"key":"regionId","value":"CH1","description":"

Required

\n","type":"text","uuid":"c06bd05f-22fd-46a9-8cd3-92287499b066"},{"key":"officeId","value":"CH1-F1079993","description":"

Required

\n","type":"text","uuid":"c7e123e2-8949-44b3-bed4-1c4dd393d5a8"},{"key":"city","value":"Laktasi","description":"

Required

\n","type":"text","uuid":"11695f75-6d9f-42dc-98c3-170e30bb7e3f"},{"key":"country","value":"Malta","description":"

Required

\n","type":"text","uuid":"c9f4e605-4ff6-499d-9850-866512ae8f71"},{"key":"offerType","value":"Sale","description":"

'Sale' or 'Rental'

\n","type":"text","uuid":"af267c30-4432-4ae7-ac79-3ab3790ea3c4"},{"key":"listingType","value":"Commercial ","description":"

'Commercial' or 'Residential'

\n","type":"text","uuid":"a67407d4-097e-4474-8f62-9510e41a3293"},{"key":"propertyType","value":"Villa","description":"

Optional

\n","type":"text","uuid":"12e658f0-54bb-494b-b8eb-a22bb931b987"},{"key":"buildingSize","value":"165","description":"

Optional

\n","type":"text","uuid":"b5853968-a2a4-45a6-804f-a3c02073e770"},{"key":"propertySize","value":"200","description":"

Optional

\n","type":"text","uuid":"db786715-4cc7-4776-b72d-22338be90333"},{"key":"sizeUnit","value":"m2","description":"

Optional

\n","type":"text","uuid":"bbc09edb-c529-4168-b76e-6bc3d44da92d"},{"key":"virtualTour","value":"No","description":"

Required

\n","type":"text","uuid":"c975dce8-bcf0-4937-88b9-dc0bb10e5872"},{"key":"noOfRooms","value":"3","description":"

Required

\n","type":"text","uuid":"8bec03ca-1424-4aa2-8ca7-aa87018529f3"},{"key":"noOfBedrooms","value":"1","description":"

Required

\n","type":"text","uuid":"d0f512f4-f37e-4497-a41d-c0269396ea86"},{"key":"noOfBathrooms","value":"2","description":"

Required

\n","type":"text","uuid":"dd142d49-adf9-41e6-8da6-82f01d39626b"},{"key":"constructionYear","value":"2000","description":"

Required

\n","type":"text","uuid":"19cee53d-eaca-4f62-9dc8-3756d23c203c"},{"key":"energyRating","value":"AAA+","description":"

Required

\n","type":"text","uuid":"c1bec5a2-e531-4d9b-ae5f-67b44e1e8a4e"},{"key":"floorNumber","value":"1","description":"

Required

\n","type":"text","uuid":"c69a17dc-f7a5-4786-bf13-81f907b595d7"},{"key":"elevatorAccess","value":"No","description":"

Required

\n","type":"text","uuid":"4879aee2-db2e-4b46-a8f0-2c7d54088563"},{"key":"outsideAreaType","value":"Garden","description":"

Optional

\n","type":"text","uuid":"00517718-43ec-43bf-8d7c-e4002ed40608"},{"key":"outsideAreaSize","value":"1000","description":"

Optional

\n","type":"text","uuid":"8953c06a-cf00-424c-ab9a-3fa6ec7720d4"},{"key":"listingPrice","value":"100000","description":"

Required

\n","type":"text","uuid":"91e73ead-4f3e-41dc-99d5-91d8f535783d"},{"key":"listingCurrency","value":"EUR","description":"

Required

\n","type":"text","uuid":"910d8628-a776-45fb-9fea-461f02bac3cb"},{"key":"datePublished","value":"2022-01-01T00:00:00Z","description":"

Required

\n","type":"text","uuid":"cc478d5e-7849-4625-8c03-6d6258d90e0f"},{"key":"dateSold","value":"2022-01-01T00:00:00Z","description":"

Optional

\n","type":"text","uuid":"332f8b8a-19b5-4268-9ffc-d7d4fb2f3a15"},{"key":"listingUrl","value":"https://listing.com/1234","description":"

Required

\n","type":"text","uuid":"5734d2f9-02be-4d1d-a69e-817a0101f6f6"},{"key":"commissionRateBuyer","value":"2","description":"

Optional

\n","type":"text","uuid":"fd93bcb8-239c-4b48-a2c5-3ce2fb71e81a"},{"key":"commissionRateSeller","value":"3","description":"

Optional

\n","type":"text","uuid":"e74d3095-ff86-4674-b683-baab78d07a24"},{"key":"contractType","value":"Open","description":"

'Open', 'Exclusive', 'Excluded for Cooperation' (required)

\n","type":"text","uuid":"55de2166-69f1-461d-824d-c70969be5ba6"},{"key":"buyerDemographic","value":"80+","description":"

'18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)

\n","type":"text","uuid":"7df49fb5-ea12-4001-9baf-1cc16e2bfde0"},{"key":"sellerDemographic","value":"80+","description":"

'18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)

\n","type":"text","uuid":"4179f5d0-9b27-4848-b056-5e3c1a3d945e"},{"key":"agentImage","value":"{\n \"webLink\" : \"test.image1.com\",\n \"description\" : \"Agent Image Test\",\n \"isPrimary\" : true\n }\n","description":"

JSON with Agent Image

\n","type":"text","uuid":"29edcf2f-51c2-4a6d-a7c8-d8ca1f397a1f"},{"key":"image","type":"file","uuid":"38920017-af4c-40c2-b4ca-e9389abdbd7a","src":"kO6kOTAGE/Screenshot 2026-03-13 at 15.49.00.png"},{"key":"image","type":"file","uuid":"457f9c99-cd1d-4b51-a263-62d55f6603a7","src":"CzB6cqSw7/Screenshot 2026-03-13 at 15.49.00.png"},{"key":"imagePrimaryFlags","value":"[\"true\", \"false\"]","description":"

Array with image primary flags

\n","type":"text","uuid":"6d4e57d5-42f0-4181-bd8b-4413de1d47da"},{"key":"imageDescriptions","value":"[\"Bedroom\", \"Bathroom\"]","description":"

Array with image descriiptions

\n","type":"text","uuid":"179948af-1945-4460-b733-ff856928c01a"}]},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings?access_token=01b9f5f4dc9b53213140e641910c767a52fb77850a1a4d1fa84bde8433ade8994f7fafe25bbcbf8a236c614f45052204ec23043d15aee3d6ece56020e6943811","description":"

This request is used to add listings to the Listings API. The API uses a queueing system, and some validation is done in the queue. If the validation fails (on agent for example), the record is still added to the database, but a flag is set to indicate some validation has failed.

\n

The body and image files should be added as form data (please refer. the body tab for examples. Image files of type JPG, JPEG and PNG are accepted, up to a maximum filesize of 3MB each, and up to a maximum of 40 images.

\n

The listing will be added to the queuing system: three parameters are passed that cannot be validated asynchronously:

\n\n

The application searches for a valid agent, region and office using the passed values. If an agent, region or office cannot be found in the RE/MAX EU Datahub database, a 'null' value is saved for agent, region or office and the appropriate flag is set: agentMatched is set if the agent is found, officeMatched is set if the office is found, regionMatched is set if the region is found.

\n","urlObject":{"protocol":"https","path":["api","v1","listings"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":"01b9f5f4dc9b53213140e641910c767a52fb77850a1a4d1fa84bde8433ade8994f7fafe25bbcbf8a236c614f45052204ec23043d15aee3d6ece56020e6943811"}],"variable":[]}},"response":[],"_postman_id":"2feb260d-1a30-4cfa-abd7-445704d0e45c"},{"name":"Add Image To Existing Listing By ListingId and RegionId","id":"ee69a334-4ef1-4fae-ac09-c3e66a713d4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","uuid":"bcb49433-6875-4e8f-b4b2-ff032bfcb4bd","src":"4mYxxdZYA/Screenshot 2026-03-06 at 16.44.36.png"},{"key":"image","type":"file","uuid":"706f8ea4-c5d6-4c64-9d8f-e1d8a84f44c1","src":"_qE42pLJQ/Screenshot 2026-03-06 at 16.44.36.png"},{"key":"imagePrimaryFlags","value":"[\"true\", \"false\"]","type":"text","uuid":"8d6ecb95-397c-4139-b407-cce0d3470566"},{"key":"imageDescriptions","value":"[\"Bedroom\", \"Bathroom\"]","type":"text","uuid":"b7b4395d-3a9e-484f-9186-7908bca62348"}]},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/addImagesByListingIdAndRegionId?access_token=access_token&listingId=listing_id®ionId=region_id","description":"

This request is used to add listings to the Listings API. The API uses a queueing system, and some validation is done in the queue. If the validation fails (on agent for example), the record is still added to the database, but a flag is set to indicate some validation has failed.

\n

The body, as per the sample below, contain certain required fields:

\n
\"listingId\" : \"test-123\", // unique identifier for listing (required)\n\"status\": \"Active\",   // can be 'Inactive', 'Active', 'Expired', 'Sold', 'Sale Agreed', 'Cancelled' (required)\n\"agentUniqueId\": \"AT-P100009\", // this is the unique agent Id from Datahub (required)\n\"title\": \"Sample Title 2\", // text title \n\"description\": \"Sample Description 2\", // text description (required)\n\"roomDescription\" : \"Sample room description\", // text (optional)\n\"bedroomDescription\" : \"Sample bedroom description\", // text (optional)\n\"bathroomDesctiption\" : \"Sample bathroom description\", // text (optional)\n\"kitchenDescription\" : \"Sample kitchen description\", // text (optional)\n\"address\": \"1234 Sample Street\", // address required\n\"streetBlock\": \"Block 4\", // street block (optional)\n\"zipcode\": \"12345\", // zipcode (required)\n\"regionId\": \"AT1\", // datahub regionId (required)\n\"officeId\":\"AT1-F1079993\", // datahub officeId (required)\n\"city\": \"Vienna2\", // city name (required)\n\"country\": \"Austria\", // country name (required)\n\"offerType\": \"Sale\", // can be 'Sale' or 'Rental' (required)\n\"listingType\": \"Commercial\", // can be 'Commercial' or 'Residential'\n\"propertyType\" : \"Villa\" , // text field (optional)\n// either buildingSize or propertySize must be passed, but both can also be passed\n\"buildingSize\": 1000.00,  // number, building size (optional)\n\"propertySize\": 2000.00,  // number, property size (optional)\n\"sizeUnit\": \"m2\",    // size unit of buildingSize and propertySize (required)\n\"virtualTour\": \"No\", // string value (required)\n\"noOfRooms\": 5, // number (optoonal)\n\"noOfBathrooms\": 2, // number (optional)\n\"noOfBedrooms\" : 3, // number (optional)\n\"constructionYear\": 2000, // construction year (required)\n\"energyRating\": \"A\", // energy rating (required)\n\"floorNumber\": \"1\",  // floor number, (required)\n\"elevatorAccess\": \"Yes\", // string value (optional, can also be null, or left out)\n\"outsideAreaType\": \"Garden\", // optional \n\"outsideAreaSize\": \"Large\", // optional\n\"listingPrice\": 1000000.00, // number value (required)\n\"listingCurrency\":  \"eur\", // Currency ISO\n\"sellPrice\": 950000.00, // sell price (optional)\n\"dateSold\": \"2022-01-01T00:00:00Z\", // optional value\n\"datePublished\": \"2022-01-01T00:00:00Z\", // required\n\"listingUrl\" : \"https://listing.com/1234\", // required\n\"commissionRateBuyer\": 3.00, // optional\n\"commissionRateSeller\": 3.00, // optional\n\"contractType\": \"Open\", // can be 'Open', 'Exclusive', 'Excluded for Cooperation' (required)\n\"buyerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"sellerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"listingImages\" : [ //images are optional\n  {\n    \"webLink\" : \"test.image1.com\", // this is required if image is passed\n    \"description\" : \"Bathroom 1\" // this is required if image is passed\n    \"isPrimary\": true // this will use the image as the cover image for the listing\n  },\n  {\n     \"webLink\" : \"test.image2.com\", // this is required if image is passed\n     \"description\" : \"Bathroom 2\" // this is required if image is passed\n     \"isPrimary\": false\n   }\n],\n\"agentImage\" : \n {\n    \"webLink\" : \"test.image1.com\",\n    \"description\" : \"Agent Image Test\",\n    \"isPrimary\" : true\n }\n\n
\n

The listing will be added to the queuing system: three parameters are passed that cannot be validated asynchronously:

\n\n

The application searches for a valid agent, region and office using the passed values. If an agent, region or office cannot be found in the RE/MAX EU Datahub database, a 'null' value is saved for agent, region or office and the appropriate flag is set: agentMatched is set if the agent is found, officeMatched is set if the office is found, regionMatched is set if the region is found.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","addImagesByListingIdAndRegionId"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":"access_token"},{"key":"listingId","value":"listing_id"},{"key":"regionId","value":"region_id"}],"variable":[]}},"response":[],"_postman_id":"ee69a334-4ef1-4fae-ac09-c3e66a713d4b"},{"name":"Get Listings Detail By RegionId and ListingId","id":"a3b07ae9-5d16-4d86-bbb2-8802076095ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/getByRegionIdAndListingId?listingId=testspecial3®ionId=GR1","description":"

This request returns detail of a listing, specifying the Remax listingId and Remax regionId as query parameters

\n
    {\n        \"id\": 1,\n        \"title\": \"Sample Title 1\",\n        \"description\": \"Sample Description 1\",\n        \"address\": \"1234 Sample Street\",\n        ...\n    },\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","listings","getByRegionIdAndListingId"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

ID added from system adding the listings

\n","type":"text/plain"},"key":"listingId","value":"testspecial3"},{"description":{"content":"

The Remax regionId for the record

\n","type":"text/plain"},"key":"regionId","value":"GR1"}],"variable":[]}},"response":[],"_postman_id":"a3b07ae9-5d16-4d86-bbb2-8802076095ca"},{"name":"Update Listing By RegionId and ListingId","id":"dc8f2671-f3a9-4ead-9950-80b443b324d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","uuid":"0ef4f16c-3788-49ba-8a24-bb1ba87a2a65","src":"z5fZOID1V/Screenshot 2026-03-06 at 16.44.36.png"},{"key":"isPrimary","value":"true","type":"text","uuid":"b58ab7db-de3f-460a-9879-5509911ad8de"},{"key":"description","value":"Updated Image Description ","type":"text","uuid":"0dbc6a3f-3fea-4e28-a465-eb40d310d673"}]},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/replaceImageByListingIdAndRegionId/400?access_token=access_token&listingId=1234-listing®ionId=region_id","description":"

This request is used to update a listing in the Listings API using the listingId and regionId field as query parameters.

\n

The body, as per the sample below, contains certain required fields:

\n
\"listingId\" : \"test-123\", // unique identifier for listing (required)\n\"status\": \"Active\",   // can be 'Inactive', 'Active', 'Expired', 'Sold', 'Sale Agreed', 'Cancelled' (required)\n\"agentUniqueId\": \"AT-P100009\", // this is the unique agent Id from Datahub (required)\n\"title\": \"Sample Title 2\", // text title (required)\n\"description\": \"Sample Description 2\", // text description (required)\n\"roomDescription\" : \"Sample room description\", // text (optional)\n\"bedroomDescription\" : \"Sample bedroom description\", // text (optional)\n\"bathroomDesctiption\" : \"Sample bathroom description\", // text (optional)\n\"kitchenDescription\" : \"Sample kitchen description\", // text (optional)\n\"address\": \"1234 Sample Street\", // address required\n\"streetBlock\": \"Block 4\", // street block (optional)\n\"zipcode\": \"12345\", // zipcode (required)\n\"regionId\": \"AT1\", // datahub regionId (required)\n\"officeId\":\"AT1-F1079993\", // datahub officeId (required)\n\"city\": \"Vienna2\", // city name (required)\n\"country\": \"Austria\", // country name (required)\n\"offerType\": \"Sale\", // can be 'Sale' or 'Rental' (required)\n\"listingType\": \"Commercial\", // can be 'Commercial' or 'Residential' (required)\n\"propertyType\" : \"Villa\" , // text field (optional)\n// either buildingSize or propertySize must be passed, but both can also be passed\n\"buildingSize\": 1000.00,  // number, building size (optional)\n\"propertySize\": 2000.00,  // number, property size (optional)\n\"sizeUnit\": \"m2\",    // size unit of buildingSize and propertySize (required)\n\"virtualTour\": \"No\", // string value (required)\n\"noOfRooms\": 5, // number (optoonal)\n\"noOfBathrooms\": 2, // number (optional)\n\"noOfBedrooms\" : 3, // number (optional)\n\"constructionYear\": 2000, // construction year (optional)\n\"energyRating\": \"A\", // energy rating (required)\n\"floorNumber\": \"1\",  // floor number (string value), \"First Floor\" or \"2\" (required)\n\"elevatorAccess\": \"Yes\", // string value (required)\n\"outsideAreaType\": \"Garden\", // optional \n\"outsideAreaSize\": \"Large\", // optional\n\"listingPrice\": 1000000.00, // number value (required)\n\"sellPrice\": 950000.00, // sell price (optional)\n\"dateSold\": \"2022-01-01T00:00:00Z\", // optional value\n\"datePublished\": \"2022-01-01T00:00:00Z\", // required\n\"listingUrl\" : \"https://listing.com/1234\", // required\n\"commissionRateBuyer\": 3.00, // optional\n\"commissionRateSeller\": 3.00, // optional\n\"contractType\": \"Open\", // can be 'Exclusive', 'Open', 'Excluded for Cooperation' (required)\n\"buyerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"sellerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"listingImages\" : [ //images are optional\n  {\n    \"webLink\" : \"test.image1.com\", // this is required if image is passed\n    \"description\" : \"Bathroom 1\" // this is required if image is passed\n  },\n  {\n     \"webLink\" : \"test.image2.com\", // this is required if image is passed\n     \"description\" : \"Bathroom 2\" // this is required if image is passed\n   }\n],\n\"agentImage\" :  // optional\n {\n    \"webLink\" : \"test.image1.com\",\n    \"description\" : \"Agent Image Test\",\n    \"isPrimary\" : true\n },\n\n
\n

The application searches for a valid agent, region and office using the passed values. If a agent, region or office cannot be found in the RE/MAX EU Datahub database, a 'null' value is saved for agent, region or office and the appropriate flag is set: agentMatched is set if the agent is found, officeMatched is set if the office is found, regionMatched is set if the region is found.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","replaceImageByListingIdAndRegionId","400"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

Access-token

\n","type":"text/plain"},"key":"access_token","value":"access_token"},{"description":{"content":"

Listing ID

\n","type":"text/plain"},"key":"listingId","value":"1234-listing"},{"description":{"content":"

Region ID

\n","type":"text/plain"},"key":"regionId","value":"region_id"}],"variable":[]}},"response":[],"_postman_id":"dc8f2671-f3a9-4ead-9950-80b443b324d6"},{"name":"Delete Listing By RegionId and ListingId","id":"b7e32158-a42a-4c44-bdc6-8d2796123dc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"listingId\" : \"test-123\",\n \"status\": \"Active\",\n \"agentUniqueId\": \"AT-P100009\",\n \"title\": \"Sample Title 2\",\n \"description\": \"Sample Description 2\",\n \"address\": \"1234 Sample Street\",\n \"streetBlock\": \"Block 4\",\n \"zipcode\": \"12345\",\n \"regionId\": 199,\n \"officeId\":2,\n \"city\": \"Vienna2\",\n \"country\": \"Austria\",\n \"offerType\": \"Sale\",\n \"listingType\": \"Commercial\",\n \"buildingSize\": 1000.00,\n \"propertySize\": 2000.00,\n \"sizeUnit\": \"m2\",\n \"virtualTour\": \"No\",\n \"noOfRooms\": 5,\n \"noOfBathrooms\": 2,\n \"constructionYear\": 2000,\n \"energyRating\": \"A\",\n \"floorNumber\": \"1\",\n \"elevatorAccess\": \"Yes\",\n \"outsideAreaType\": \"Garden\",\n \"outsideAreaSize\": \"Large\",\n \"listingPrice\": 1000000.00,\n \"sellPrice\": 950000.00,\n \"dateSold\": \"2022-01-01T00:00:00Z\",\n \"datePublished\": \"2022-01-01T00:00:00Z\",\n \"commissionRateBuyer\": 3.00,\n \"commissionRateSeller\": 3.00,\n \"contractType\": \"Commercial\",\n \"buyerDemographic\": \"80+\",\n \"sellerDemographic\": \"80+\",\n \"listingImages\" : [\n {\n \"webLink\" : \"test.image1.com\",\n \"description\" : \"Bathroom 1\"\n },\n {\n \"webLink\" : \"test.image2.com\",\n \"description\" : \"Bathroom 2\"\n }\n ]\n \n}","options":{"raw":{"language":"json"}}},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/deleteByRegionIdAndListingId?access_token=&listingId=test1234®ionId=GB1","description":"

This request is used to delete a listing in the Listings API using the listingId and regionId as identifier.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","deleteByRegionIdAndListingId"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""},{"description":{"content":"

The listingId value for the record

\n","type":"text/plain"},"key":"listingId","value":"test1234"},{"description":{"content":"

The regionId value for the record

\n","type":"text/plain"},"key":"regionId","value":"GB1"}],"variable":[]}},"response":[],"_postman_id":"b7e32158-a42a-4c44-bdc6-8d2796123dc6"},{"name":"Delete Listing Image By RegionId an ListingId","id":"66bcfd5a-a40e-458a-b5a4-03e1b9641c39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"listingId\" : \"test-123\",\n \"status\": \"Active\",\n \"agentUniqueId\": \"AT-P100009\",\n \"title\": \"Sample Title 2\",\n \"description\": \"Sample Description 2\",\n \"address\": \"1234 Sample Street\",\n \"streetBlock\": \"Block 4\",\n \"zipcode\": \"12345\",\n \"regionId\": 199,\n \"officeId\":2,\n \"city\": \"Vienna2\",\n \"country\": \"Austria\",\n \"offerType\": \"Sale\",\n \"listingType\": \"Commercial\",\n \"buildingSize\": 1000.00,\n \"propertySize\": 2000.00,\n \"sizeUnit\": \"m2\",\n \"virtualTour\": \"No\",\n \"noOfRooms\": 5,\n \"noOfBathrooms\": 2,\n \"constructionYear\": 2000,\n \"energyRating\": \"A\",\n \"floorNumber\": \"1\",\n \"elevatorAccess\": \"Yes\",\n \"outsideAreaType\": \"Garden\",\n \"outsideAreaSize\": \"Large\",\n \"listingPrice\": 1000000.00,\n \"sellPrice\": 950000.00,\n \"dateSold\": \"2022-01-01T00:00:00Z\",\n \"datePublished\": \"2022-01-01T00:00:00Z\",\n \"commissionRateBuyer\": 3.00,\n \"commissionRateSeller\": 3.00,\n \"contractType\": \"Commercial\",\n \"buyerDemographic\": \"80+\",\n \"sellerDemographic\": \"80+\",\n \"listingImages\" : [\n {\n \"webLink\" : \"test.image1.com\",\n \"description\" : \"Bathroom 1\"\n },\n {\n \"webLink\" : \"test.image2.com\",\n \"description\" : \"Bathroom 2\"\n }\n ]\n \n}","options":{"raw":{"language":"json"}}},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/deleteImageByListingIdAndRegionId/?access_token=access_token®ionId=FI1&listingId=1234-listing","description":"

This request is used to delete a listing in the Listings API using the listingId and regionId as identifier.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","deleteImageByListingIdAndRegionId",""],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":"access_token"},{"description":{"content":"

region Id

\n","type":"text/plain"},"key":"regionId","value":"FI1"},{"description":{"content":"

listing Id

\n","type":"text/plain"},"key":"listingId","value":"1234-listing"}],"variable":[]}},"response":[],"_postman_id":"66bcfd5a-a40e-458a-b5a4-03e1b9641c39"},{"name":"Get Region Detail By RemaxId","id":"ad55bde1-e8b4-45ec-bf53-8edf00d03de0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/regions/getByRemaxId/TR1?access_token=","description":"

This request returns all regions that are used in the Listings API, i.e. regions that have listings assigned to them.

\n","urlObject":{"protocol":"https","path":["api","v1","regions","getByRemaxId","TR1"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"ad55bde1-e8b4-45ec-bf53-8edf00d03de0"},{"name":"Get Listing Entry Logs","id":"b64e23ee-9fd0-4073-85d0-a1e9b5b85e48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listinglogs?access_token=","description":"

This request returns all listing entry logs, this indicates wether a entry has been successful or has failed.

\n","urlObject":{"protocol":"https","path":["api","v1","listinglogs"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"b64e23ee-9fd0-4073-85d0-a1e9b5b85e48"},{"name":"Get Listing Entry Log By Id","id":"e5689de6-9ade-4507-be8e-7fffa3fad534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listinglogs/2?access_token=","description":"

This request returns a listing entry log by ID. The id is passed as a query parameter

\n","urlObject":{"protocol":"https","path":["api","v1","listinglogs","2"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"e5689de6-9ade-4507-be8e-7fffa3fad534"},{"name":"Get Failed Listing Entry Logs","id":"ba531451-b3b4-4df2-8b47-b0147a8d686d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listinglogs/failed?access_token=","description":"

This request returns all failed listing entry logs (success : false). The payload and the reason for failure is also returned.

\n","urlObject":{"protocol":"https","path":["api","v1","listinglogs","failed"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"ba531451-b3b4-4df2-8b47-b0147a8d686d"},{"name":"Get Listing Entry Logs By ListingId","id":"b3cc7f4c-3629-4f7a-a834-b70d40936aae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listinglogs/listingId/?access_token=","description":"

This request returns the listing entry log records for a specific listing Id, this is the listingId value that is passed when submitting an entry log.

\n","urlObject":{"protocol":"https","path":["api","v1","listinglogs","listingId",""],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"b3cc7f4c-3629-4f7a-a834-b70d40936aae"},{"name":"Get Listing Entry Logs By RegionId","id":"48ddabcc-ce4b-4292-a9c1-33134b5511f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listinglogs/regionId/?access_token=","description":"

This request returns all listing entry logs for a specific regionId, this is the Remax regionId.

\n","urlObject":{"protocol":"https","path":["api","v1","listinglogs","regionId",""],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"48ddabcc-ce4b-4292-a9c1-33134b5511f7"},{"name":"Get Office Detail by RemaxId","id":"774e2aa7-2997-45a4-9f32-3e84da10e334","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/offices/getByRemaxId/AT1-F100199?access_token=","description":"

This request returns office detail, using the Remax officeId as a route parameter. This also returns listings associated with an office.

\n","urlObject":{"protocol":"https","path":["api","v1","offices","getByRemaxId","AT1-F100199"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"774e2aa7-2997-45a4-9f32-3e84da10e334"},{"name":"Get Agent Detail By RemaxId","id":"0cda2484-2ede-48bf-9dd1-975f058b248d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/agents/getByRemaxId/ch1-p12345?access_token=","description":"

This request returns the detail of a specific agent with the specified Remax agentId passed as a route parameter.

\n","urlObject":{"protocol":"https","path":["api","v1","agents","getByRemaxId","ch1-p12345"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"0cda2484-2ede-48bf-9dd1-975f058b248d"},{"name":"Update Image On Listing By Listing ID and Region ID","id":"7f5c4fa1-1980-4d17-b88f-3d2d8076c8b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","description":"

Image

\n","type":"file","uuid":"5aaf96c7-8201-4583-958c-2b5529aa4512","src":"NrXYrvhvH/Screenshot 2026-03-06 at 16.44.36.png"},{"key":"isPrimary","value":"true","type":"text","uuid":"c2f0b00b-6479-4030-aa97-6f733d8fc669"},{"key":"description","value":"Updated Image Description","type":"text","uuid":"c632a021-b91d-4f56-a21e-d30301953cec"}]},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/109/images/388?access_token=access_token","description":"

This request is used to update a listing in the Listings API using the listing Id as route parameter.

\n

The body, as per the sample below, contains certain required fields:

\n
\"listingId\" : \"test-123\", // unique identifier for listing (required)\n\"status\": \"Active\",   // can be 'Inactive', 'Active', 'Expired', 'Sold', 'Sale Agreed', 'Cancelled' (required)\n\"agentUniqueId\": \"AT-P100009\", // this is the unique agent Id from Datahub (required)\n\"title\": \"Sample Title 2\", // text title (required)\n\"description\": \"Sample Description 2\", // text description (required)\n\"roomDescription\" : \"Sample room description\", // text (optional)\n\"bedroomDescription\" : \"Sample bedroom description\", // text (optional)\n\"bathroomDesctiption\" : \"Sample bathroom description\", // text (optional)\n\"kitchenDescription\" : \"Sample kitchen description\", // text (optional)\n\"address\": \"1234 Sample Street\", // address required\n\"streetBlock\": \"Block 4\", // street block (optional)\n\"zipcode\": \"12345\", // zipcode (required)\n\"regionId\": \"AT1\", // datahub regionId (required)\n\"officeId\":\"AT1-F1079993\", // datahub officeId (required)\n\"city\": \"Vienna2\", // city name (required)\n\"country\": \"Austria\", // country name (required)\n\"offerType\": \"Sale\", // can be 'Sale' or 'Rental' (required)\n\"listingType\": \"Commercial\", // can be 'Commercial' or 'Residential' (required)\n\"propertyType\" : \"Villa\" , // text field (optional)\n// either buildingSize or propertySize must be passed, but both can also be passed\n\"buildingSize\": 1000.00,  // number, building size (optional)\n\"propertySize\": 2000.00,  // number, property size (optional)\n\"sizeUnit\": \"m2\",    // size unit of buildingSize and propertySize (required)\n\"virtualTour\": \"No\", // string value (required)\n\"noOfRooms\": 5, // number (optoonal)\n\"noOfBathrooms\": 2, // number (optional)\n\"noOfBedrooms\" : 3, // number (optional)\n\"constructionYear\": 2000, // construction year (required)\n\"energyRating\": \"A\", // energy rating (required)\n\"floorNumber\": \"1\",  // floor number (string value), \"First Floor\" or \"2\" (required)\n\"elevatorAccess\": \"Yes\", // string value (required)\n\"outsideAreaType\": \"Garden\", // optional \n\"outsideAreaSize\": \"Large\", // optional\n\"listingPrice\": 1000000.00, // number value (required)\n\"sellPrice\": 950000.00, // sell price (optional)\n\"dateSold\": \"2022-01-01T00:00:00Z\", // optional value\n\"datePublished\": \"2022-01-01T00:00:00Z\", // required\n\"commissionRateBuyer\": 3.00, // optional\n\"commissionRateSeller\": 3.00, // optional\n\"contractType\": \"Open\", // can be 'Exclusive', 'Open', 'Excluded for Cooperation' (required)\n\"buyerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"sellerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"listingImages\" : [ //images are optional\n  {\n    \"webLink\" : \"test.image1.com\", // this is required if image is passed\n    \"description\" : \"Bathroom 1\" // this is required if image is passed\n  },\n  {\n     \"webLink\" : \"test.image2.com\", // this is required if image is passed\n     \"description\" : \"Bathroom 2\" // this is required if image is passed\n   }\n],\n\"agentImage\" :  // optional\n {\n    \"webLink\" : \"test.image1.com\",\n    \"description\" : \"Agent Image Test\",\n    \"isPrimary\" : true\n },\n\n
\n

The application searches for a valid agent, region and office using the passed values. If a agent, region or office cannot be found in the RE/MAX EU Datahub database, a 'null' value is saved for agent, region or office and the appropriate flag is set: agentMatched is set if the agent is found, officeMatched is set if the office is found, regionMatched is set if the region is found.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","109","images","388"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":"access_token"}],"variable":[]}},"response":[],"_postman_id":"7f5c4fa1-1980-4d17-b88f-3d2d8076c8b7"}],"id":"b77ac2be-c9d4-420f-aa18-520cb2851a7b","description":"

Collection of calls for adding, updating, deleting listings based on Datahub's region ID and the provided Listing ID

\n

Get calls for agents, offices and region are based on the Datahub IDs as well.

\n","_postman_id":"b77ac2be-c9d4-420f-aa18-520cb2851a7b","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""}]},"isInherited":true,"source":{"_postman_id":"8927220b-2631-4058-9ccf-cf2eaaee4173","id":"8927220b-2631-4058-9ccf-cf2eaaee4173","name":"RE/MAX EU - Listings API","type":"collection"}}},{"name":"Authenticate with OAuth Server","id":"4d2645f0-54b2-4d4c-a922-246999dcef6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"grant_type","value":""},{"key":"password","value":""},{"key":"username","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"state","value":""},{"key":"scope","value":""},{"key":"tokenName","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"","description":"

Auth URL: https://oauth.pre-prod.remaxeu-datahub.bwscloud.tech/authorize

\n

Access Token URL: https://oauth.pre-prod.remaxeu-datahub.bwscloud.tech/token

\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"4d2645f0-54b2-4d4c-a922-246999dcef6d"},{"name":"Add Image To Existing Listing","id":"7fd234c5-7098-4c4a-abbb-6525952446b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","uuid":"bcb49433-6875-4e8f-b4b2-ff032bfcb4bd","src":"4mYxxdZYA/Screenshot 2026-03-06 at 16.44.36.png"},{"key":"image","type":"file","uuid":"706f8ea4-c5d6-4c64-9d8f-e1d8a84f44c1","src":"_qE42pLJQ/Screenshot 2026-03-06 at 16.44.36.png"},{"key":"imagePrimaryFlags","value":"[\"true\", \"false\"]","type":"text","uuid":"8d6ecb95-397c-4139-b407-cce0d3470566"},{"key":"imageDescriptions","value":"[\"Bedroom\", \"Bathroom\"]","type":"text","uuid":"b7b4395d-3a9e-484f-9186-7908bca62348"}]},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings//images?access_token=access_token","description":"

This request is used to add listings to the Listings API. The API uses a queueing system, and some validation is done in the queue. If the validation fails (on agent for example), the record is still added to the database, but a flag is set to indicate some validation has failed.

\n

The body, as per the sample below, contain certain required fields:

\n
\"listingId\" : \"test-123\", // unique identifier for listing (required)\n\"status\": \"Active\",   // can be 'Inactive', 'Active', 'Expired', 'Sold', 'Sale Agreed', 'Cancelled' (required)\n\"agentUniqueId\": \"AT-P100009\", // this is the unique agent Id from Datahub (required)\n\"title\": \"Sample Title 2\", // text title \n\"description\": \"Sample Description 2\", // text description (required)\n\"roomDescription\" : \"Sample room description\", // text (optional)\n\"bedroomDescription\" : \"Sample bedroom description\", // text (optional)\n\"bathroomDesctiption\" : \"Sample bathroom description\", // text (optional)\n\"kitchenDescription\" : \"Sample kitchen description\", // text (optional)\n\"address\": \"1234 Sample Street\", // address required\n\"streetBlock\": \"Block 4\", // street block (optional)\n\"zipcode\": \"12345\", // zipcode (required)\n\"regionId\": \"AT1\", // datahub regionId (required)\n\"officeId\":\"AT1-F1079993\", // datahub officeId (required)\n\"city\": \"Vienna2\", // city name (required)\n\"country\": \"Austria\", // country name (required)\n\"offerType\": \"Sale\", // can be 'Sale' or 'Rental' (required)\n\"listingType\": \"Commercial\", // can be 'Commercial' or 'Residential'\n\"propertyType\" : \"Villa\" , // text field (optional)\n// either buildingSize or propertySize must be passed, but both can also be passed\n\"buildingSize\": 1000.00,  // number, building size (optional)\n\"propertySize\": 2000.00,  // number, property size (optional)\n\"sizeUnit\": \"m2\",    // size unit of buildingSize and propertySize (required)\n\"virtualTour\": \"No\", // string value (required)\n\"noOfRooms\": 5, // number (optoonal)\n\"noOfBathrooms\": 2, // number (optional)\n\"noOfBedrooms\" : 3, // number (optional)\n\"constructionYear\": 2000, // construction year (required)\n\"energyRating\": \"A\", // energy rating (required)\n\"floorNumber\": \"1\",  // floor number, (required)\n\"elevatorAccess\": \"Yes\", // string value (optional, can also be null, or left out)\n\"outsideAreaType\": \"Garden\", // optional \n\"outsideAreaSize\": \"Large\", // optional\n\"listingPrice\": 1000000.00, // number value (required)\n\"listingCurrency\":  \"eur\", // Currency ISO\n\"sellPrice\": 950000.00, // sell price (optional)\n\"dateSold\": \"2022-01-01T00:00:00Z\", // optional value\n\"datePublished\": \"2022-01-01T00:00:00Z\", // required\n\"listingUrl\" : \"https://listing.com/1234\", // required\n\"commissionRateBuyer\": 3.00, // optional\n\"commissionRateSeller\": 3.00, // optional\n\"contractType\": \"Open\", // can be 'Open', 'Exclusive', 'Excluded for Cooperation' (required)\n\"buyerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"sellerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"listingImages\" : [ //images are optional\n  {\n    \"webLink\" : \"test.image1.com\", // this is required if image is passed\n    \"description\" : \"Bathroom 1\" // this is required if image is passed\n    \"isPrimary\": true // this will use the image as the cover image for the listing\n  },\n  {\n     \"webLink\" : \"test.image2.com\", // this is required if image is passed\n     \"description\" : \"Bathroom 2\" // this is required if image is passed\n     \"isPrimary\": false\n   }\n],\n\"agentImage\" : \n {\n    \"webLink\" : \"test.image1.com\",\n    \"description\" : \"Agent Image Test\",\n    \"isPrimary\" : true\n }\n\n
\n

The listing will be added to the queuing system: three parameters are passed that cannot be validated asynchronously:

\n
    \n

  • agentId

    \n
    • \n

  • regionId

    \n
    • \n

  • officeId

    \n
    • \n
\n

The application searches for a valid agent, region and office using the passed values. If an agent, region or office cannot be found in the RE/MAX EU Datahub database, a 'null' value is saved for agent, region or office and the appropriate flag is set: agentMatched is set if the agent is found, officeMatched is set if the office is found, regionMatched is set if the region is found.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","","images"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":"access_token"}],"variable":[]}},"response":[],"_postman_id":"7fd234c5-7098-4c4a-abbb-6525952446b6"},{"name":"Update Listing","id":"3a65aac0-3a07-482e-bec5-ecce5beb1f46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"listingId\" : \"test-12345\",\n \"status\": \"Active\",\n \"agentUniqueId\": \"CH2-P100002\",\n \"title\": \"Sample Title 2\",\n \"description\": \"Sample Description 2\",\n \"roomDescription\" : \"Sample room description\",\n \"bathroomDescription\" : \"Sample bathroom description\",\n \"bedroomDescription\" : \"Sample bedroom description\",\n \"kitchenDescription\" : \"Sample kitchen description\",\n \"address\": \"1234 Sample Street\",\n \"streetBlock\": \"Block 4\",\n \"zipcode\": \"12345\",\n \"regionId\": \"FI1\",\n \"officeId\":\"FI1-F1079993\",\n \"city\": \"Friesneksor\",\n \"country\": \"Finland\",\n \"offerType\": \"Sale\",\n \"listingType\": \"Commercial\",\n \"buildingSize\": 1000.00,\n \"propertySize\": 2000.00,\n \"sizeUnit\": \"m2\",\n \"virtualTour\": \"No\",\n \"noOfRooms\": 5,\n \"noOfBathrooms\": 2,\n \"noOfBedrooms\" : 2,\n \"constructionYear\": 2000,\n \"energyRating\": \"A\",\n \"floorNumber\": \"1\",\n \"elevatorAccess\": \"Yes\",\n \"outsideAreaType\": \"Garden\",\n \"outsideAreaSize\": \"Large\",\n \"listingPrice\": 1000000.00,\n \"sellPrice\": 950000.00,\n \"dateSold\": \"2022-01-01T00:00:00Z\",\n \"datePublished\": \"2022-01-01T00:00:00Z\",\n \"commissionRateBuyer\": 3.00,\n \"commissionRateSeller\": 3.00,\n \"contractType\": \"Commercial\",\n \"buyerDemographic\": \"80+\",\n \"sellerDemographic\": \"80+\",\n \"listingImages\" : [\n {\n \"webLink\" : \"test.image1.com\",\n \"description\" : \"Bathroom 1\"\n },\n {\n \"webLink\" : \"test.image2.com\",\n \"description\" : \"Bathroom 2\"\n }\n ]\n \n}","options":{"raw":{"language":"json"}}},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/1?access_token=","description":"

This request is used to update a listing in the Listings API using the listing Id as route parameter.

\n

The body, as per the sample below, contains certain required fields:

\n
\"listingId\" : \"test-123\", // unique identifier for listing (required)\n\"status\": \"Active\",   // can be 'Inactive', 'Active', 'Expired', 'Sold', 'Sale Agreed', 'Cancelled' (required)\n\"agentUniqueId\": \"AT-P100009\", // this is the unique agent Id from Datahub (required)\n\"title\": \"Sample Title 2\", // text title (required)\n\"description\": \"Sample Description 2\", // text description (required)\n\"roomDescription\" : \"Sample room description\", // text (optional)\n\"bedroomDescription\" : \"Sample bedroom description\", // text (optional)\n\"bathroomDesctiption\" : \"Sample bathroom description\", // text (optional)\n\"kitchenDescription\" : \"Sample kitchen description\", // text (optional)\n\"address\": \"1234 Sample Street\", // address required\n\"streetBlock\": \"Block 4\", // street block (optional)\n\"zipcode\": \"12345\", // zipcode (required)\n\"regionId\": \"AT1\", // datahub regionId (required)\n\"officeId\":\"AT1-F1079993\", // datahub officeId (required)\n\"city\": \"Vienna2\", // city name (required)\n\"country\": \"Austria\", // country name (required)\n\"offerType\": \"Sale\", // can be 'Sale' or 'Rental' (required)\n\"listingType\": \"Commercial\", // can be 'Commercial' or 'Residential' (required)\n\"propertyType\" : \"Villa\" , // text field (optional)\n// either buildingSize or propertySize must be passed, but both can also be passed\n\"buildingSize\": 1000.00,  // number, building size (optional)\n\"propertySize\": 2000.00,  // number, property size (optional)\n\"sizeUnit\": \"m2\",    // size unit of buildingSize and propertySize (required)\n\"virtualTour\": \"No\", // string value (required)\n\"noOfRooms\": 5, // number (optoonal)\n\"noOfBathrooms\": 2, // number (optional)\n\"noOfBedrooms\" : 3, // number (optional)\n\"constructionYear\": 2000, // construction year (required)\n\"energyRating\": \"A\", // energy rating (required)\n\"floorNumber\": \"1\",  // floor number (string value), \"First Floor\" or \"2\" (required)\n\"elevatorAccess\": \"Yes\", // string value (required)\n\"outsideAreaType\": \"Garden\", // optional \n\"outsideAreaSize\": \"Large\", // optional\n\"listingPrice\": 1000000.00, // number value (required)\n\"sellPrice\": 950000.00, // sell price (optional)\n\"dateSold\": \"2022-01-01T00:00:00Z\", // optional value\n\"datePublished\": \"2022-01-01T00:00:00Z\", // required\n\"commissionRateBuyer\": 3.00, // optional\n\"commissionRateSeller\": 3.00, // optional\n\"contractType\": \"Open\", // can be 'Exclusive', 'Open', 'Excluded for Cooperation' (required)\n\"buyerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"sellerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"listingImages\" : [ //images are optional\n  {\n    \"webLink\" : \"test.image1.com\", // this is required if image is passed\n    \"description\" : \"Bathroom 1\" // this is required if image is passed\n  },\n  {\n     \"webLink\" : \"test.image2.com\", // this is required if image is passed\n     \"description\" : \"Bathroom 2\" // this is required if image is passed\n   }\n],\n\"agentImage\" :  // optional\n {\n    \"webLink\" : \"test.image1.com\",\n    \"description\" : \"Agent Image Test\",\n    \"isPrimary\" : true\n },\n\n
\n

The application searches for a valid agent, region and office using the passed values. If a agent, region or office cannot be found in the RE/MAX EU Datahub database, a 'null' value is saved for agent, region or office and the appropriate flag is set: agentMatched is set if the agent is found, officeMatched is set if the office is found, regionMatched is set if the region is found.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","1"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"3a65aac0-3a07-482e-bec5-ecce5beb1f46"},{"name":"Update Image On Listing","id":"935ac6b3-a925-4ce7-8004-5c59698037e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","description":"

Image

\n","type":"file","uuid":"5aaf96c7-8201-4583-958c-2b5529aa4512","src":"NrXYrvhvH/Screenshot 2026-03-06 at 16.44.36.png"},{"key":"isPrimary","value":"true","type":"text","uuid":"c2f0b00b-6479-4030-aa97-6f733d8fc669"},{"key":"description","value":"Updated Image Description","type":"text","uuid":"c632a021-b91d-4f56-a21e-d30301953cec"}]},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings//images/?access_token=access_token","description":"

This request is used to update a listing in the Listings API using the listing Id as route parameter.

\n

The body, as per the sample below, contains certain required fields:

\n
\"listingId\" : \"test-123\", // unique identifier for listing (required)\n\"status\": \"Active\",   // can be 'Inactive', 'Active', 'Expired', 'Sold', 'Sale Agreed', 'Cancelled' (required)\n\"agentUniqueId\": \"AT-P100009\", // this is the unique agent Id from Datahub (required)\n\"title\": \"Sample Title 2\", // text title (required)\n\"description\": \"Sample Description 2\", // text description (required)\n\"roomDescription\" : \"Sample room description\", // text (optional)\n\"bedroomDescription\" : \"Sample bedroom description\", // text (optional)\n\"bathroomDesctiption\" : \"Sample bathroom description\", // text (optional)\n\"kitchenDescription\" : \"Sample kitchen description\", // text (optional)\n\"address\": \"1234 Sample Street\", // address required\n\"streetBlock\": \"Block 4\", // street block (optional)\n\"zipcode\": \"12345\", // zipcode (required)\n\"regionId\": \"AT1\", // datahub regionId (required)\n\"officeId\":\"AT1-F1079993\", // datahub officeId (required)\n\"city\": \"Vienna2\", // city name (required)\n\"country\": \"Austria\", // country name (required)\n\"offerType\": \"Sale\", // can be 'Sale' or 'Rental' (required)\n\"listingType\": \"Commercial\", // can be 'Commercial' or 'Residential' (required)\n\"propertyType\" : \"Villa\" , // text field (optional)\n// either buildingSize or propertySize must be passed, but both can also be passed\n\"buildingSize\": 1000.00,  // number, building size (optional)\n\"propertySize\": 2000.00,  // number, property size (optional)\n\"sizeUnit\": \"m2\",    // size unit of buildingSize and propertySize (required)\n\"virtualTour\": \"No\", // string value (required)\n\"noOfRooms\": 5, // number (optoonal)\n\"noOfBathrooms\": 2, // number (optional)\n\"noOfBedrooms\" : 3, // number (optional)\n\"constructionYear\": 2000, // construction year (required)\n\"energyRating\": \"A\", // energy rating (required)\n\"floorNumber\": \"1\",  // floor number (string value), \"First Floor\" or \"2\" (required)\n\"elevatorAccess\": \"Yes\", // string value (required)\n\"outsideAreaType\": \"Garden\", // optional \n\"outsideAreaSize\": \"Large\", // optional\n\"listingPrice\": 1000000.00, // number value (required)\n\"sellPrice\": 950000.00, // sell price (optional)\n\"dateSold\": \"2022-01-01T00:00:00Z\", // optional value\n\"datePublished\": \"2022-01-01T00:00:00Z\", // required\n\"commissionRateBuyer\": 3.00, // optional\n\"commissionRateSeller\": 3.00, // optional\n\"contractType\": \"Open\", // can be 'Exclusive', 'Open', 'Excluded for Cooperation' (required)\n\"buyerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"sellerDemographic\": \"80+\", // can be '18 - 35', '36 - 50', '51 - 65', '66 - 80', '80+' (optional)\n\"listingImages\" : [ //images are optional\n  {\n    \"webLink\" : \"test.image1.com\", // this is required if image is passed\n    \"description\" : \"Bathroom 1\" // this is required if image is passed\n  },\n  {\n     \"webLink\" : \"test.image2.com\", // this is required if image is passed\n     \"description\" : \"Bathroom 2\" // this is required if image is passed\n   }\n],\n\"agentImage\" :  // optional\n {\n    \"webLink\" : \"test.image1.com\",\n    \"description\" : \"Agent Image Test\",\n    \"isPrimary\" : true\n },\n\n
\n

The application searches for a valid agent, region and office using the passed values. If a agent, region or office cannot be found in the RE/MAX EU Datahub database, a 'null' value is saved for agent, region or office and the appropriate flag is set: agentMatched is set if the agent is found, officeMatched is set if the office is found, regionMatched is set if the region is found.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","","images",""],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"key":"access_token","value":"access_token"}],"variable":[]}},"response":[],"_postman_id":"935ac6b3-a925-4ce7-8004-5c59698037e5"},{"name":"Delete Listing","id":"fc589dea-6c03-4cdb-a358-c3e2222fe782","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"listingId\" : \"test-123\",\n \"status\": \"Active\",\n \"agentUniqueId\": \"AT-P100009\",\n \"title\": \"Sample Title 2\",\n \"description\": \"Sample Description 2\",\n \"address\": \"1234 Sample Street\",\n \"streetBlock\": \"Block 4\",\n \"zipcode\": \"12345\",\n \"regionId\": 199,\n \"officeId\":2,\n \"city\": \"Vienna2\",\n \"country\": \"Austria\",\n \"offerType\": \"Sale\",\n \"listingType\": \"Commercial\",\n \"buildingSize\": 1000.00,\n \"propertySize\": 2000.00,\n \"sizeUnit\": \"m2\",\n \"virtualTour\": \"No\",\n \"noOfRooms\": 5,\n \"noOfBathrooms\": 2,\n \"constructionYear\": 2000,\n \"energyRating\": \"A\",\n \"floorNumber\": \"1\",\n \"elevatorAccess\": \"Yes\",\n \"outsideAreaType\": \"Garden\",\n \"outsideAreaSize\": \"Large\",\n \"listingPrice\": 1000000.00,\n \"sellPrice\": 950000.00,\n \"dateSold\": \"2022-01-01T00:00:00Z\",\n \"datePublished\": \"2022-01-01T00:00:00Z\",\n \"commissionRateBuyer\": 3.00,\n \"commissionRateSeller\": 3.00,\n \"contractType\": \"Commercial\",\n \"buyerDemographic\": \"80+\",\n \"sellerDemographic\": \"80+\",\n \"listingImages\" : [\n {\n \"webLink\" : \"test.image1.com\",\n \"description\" : \"Bathroom 1\"\n },\n {\n \"webLink\" : \"test.image2.com\",\n \"description\" : \"Bathroom 2\"\n }\n ]\n \n}","options":{"raw":{"language":"json"}}},"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/1?access_token=","description":"

This request is used to delete a listing in the Listings API using the Id of the listing as route parameter.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","1"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"fc589dea-6c03-4cdb-a358-c3e2222fe782"},{"name":"Delete Image On Listing","id":"592635dd-025b-44a9-a5f8-2fc131814b2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings//images/?access_token=access_token","description":"

This request is used to delete a listing in the Listings API using the Id of the listing as route parameter.

\n","urlObject":{"protocol":"https","path":["api","v1","listings","","images",""],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":"access_token"}],"variable":[]}},"response":[],"_postman_id":"592635dd-025b-44a9-a5f8-2fc131814b2f"},{"name":"Get Listings","id":"f5f9cc62-4d53-4295-a3df-49e602ebb584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings","description":"

This request returns all active listings (where isDeleted is false),

\n

Search Parameters

\n

The following search parameters can be passed to filter listings:

\n
    \n

  • country - string value i.e. Austria, also searches for partial matches

    \n
    • \n

  • city - string value i.e. Vienna, also searches for partial matches

    \n
    • \n

  • offerType - 'Sale' or 'Rental'

    \n
    • \n

  • listingType - 'Commercial' or 'Residential'

    \n
    • \n

  • sizeMin - filters on propertySize larger or equal to sizeMin

    \n
    • \n

  • sizeMax- filters on propertySize smaller or equal to sizeMax

    \n
    • \n

  • priceMin - filters on listingPrice larger or equal to priceMin

    \n
    • \n

  • priceMax - filters on listingPrice smaller or equal to priceMax

    \n
    • \n

  • status - filters on listing status 1 (Active), 2 (Expired), 3 (Sold), 4 (Sale Agreed), 5 (Cancelled), 6 (Inactive)

    \n
    • \n
\n

The return object will look as follows:

\n
[\n    {\n        \"id\": 1,\n        \"title\": \"Sample Title 1\",\n        \"description\": \"Sample Description 1\",\n        \"address\": \"1234 Sample Street\",\n        ...\n    },\n    {\n        \"id\": 2,\n        \"title\": \"Sample Title 2\",\n        \"description\": \"Sample Description 2\",\n        \"address\": \"1234 Sample Street\",\n        ...\n    }\n]\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","listings"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"disabled":true,"description":{"content":"

Page Number, starting at 1

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Limit, number of rows to return

\n","type":"text/plain"},"key":"limit","value":"25"},{"disabled":true,"description":{"content":"

Country to filter by

\n","type":"text/plain"},"key":"country","value":"aus"},{"disabled":true,"description":{"content":"

City to filter by

\n","type":"text/plain"},"key":"city","value":"vien"},{"disabled":true,"description":{"content":"

sale or rental

\n","type":"text/plain"},"key":"offerType","value":"sale"},{"disabled":true,"description":{"content":"

commercial or residential

\n","type":"text/plain"},"key":"listingType","value":"commercial"},{"disabled":true,"description":{"content":"

Minimum propertySize to filter on

\n","type":"text/plain"},"key":"sizeMin","value":"500"},{"disabled":true,"description":{"content":"

Maximum propertySize to filter on

\n","type":"text/plain"},"key":"sizeMax","value":"3000"},{"disabled":true,"description":{"content":"

Minimum listingPrice to filter on

\n","type":"text/plain"},"key":"priceMin","value":"50000"},{"disabled":true,"description":{"content":"

Maximum listingPrice to filter on

\n","type":"text/plain"},"key":"priceMax","value":"1000000"},{"disabled":true,"description":{"content":"

Accepts a comma seperated list of values to do a strict search on, for example if the value is balcony, garden, it will search where outsideAreaType has balcony and garden

\n","type":"text/plain"},"key":"outsideAreaType","value":"balcony,garden"},{"disabled":true,"description":{"content":"

Searches for values where the noOfRooms parameter is equal to or greater than the parameter value

\n","type":"text/plain"},"key":"roomsMin","value":"4"},{"disabled":true,"description":{"content":"

Accepts two values: true or false, if true, the API returns all listings where the elevatorAccess value is not null or empty. If false, the API returns all listings where the elevatorAccess is null or empty

\n","type":"text/plain"},"key":"elevatorAccess","value":"true"},{"disabled":true,"description":{"content":"

Accepts single or combination of values: 1 (Active), 2 (Expired), 3 (Sold), 4 (Sale Agreed), 5 (Cancelled), 6 (Inactive)

\n","type":"text/plain"},"key":"status","value":"1,2"}],"variable":[]}},"response":[],"_postman_id":"f5f9cc62-4d53-4295-a3df-49e602ebb584"},{"name":"Get Random Listings","id":"dec4b7aa-0097-4adf-9901-c6d16bcf7419","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/random","description":"

This request returns random listings based on the user's location. The requester IP address is used to determine the location of the user, if the user cannot be located, 10 random listings are returned.

\n

The return object will look as follows:

\n
[\n    {\n        \"id\": 1,\n        \"title\": \"Sample Title 1\",\n        \"description\": \"Sample Description 1\",\n        \"address\": \"1234 Sample Street\",\n        ...\n    },\n    {\n        \"id\": 2,\n        \"title\": \"Sample Title 2\",\n        \"description\": \"Sample Description 2\",\n        \"address\": \"1234 Sample Street\",\n        ...\n    }\n]\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","listings","random"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[],"variable":[]}},"response":[],"_postman_id":"dec4b7aa-0097-4adf-9901-c6d16bcf7419"},{"name":"Get Listings Detail","id":"ca456a9a-a301-4488-9cef-25ee3a78a438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings?id=1","description":"

This request returns detail of a listing, specifying the id as parameter

\n

Search Parameters

\n

The following search parameters can be passed to filter listings:

\n
    \n
  • id - the unique id of a listing, as returned when getting all listings, or filtering listings
    • \n
\n
    {\n        \"id\": 1,\n        \"title\": \"Sample Title 1\",\n        \"description\": \"Sample Description 1\",\n        \"address\": \"1234 Sample Street\",\n        ...\n    },\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","listings"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

Identifier of the listing to search

\n","type":"text/plain"},"key":"id","value":"1"}],"variable":[]}},"response":[],"_postman_id":"ca456a9a-a301-4488-9cef-25ee3a78a438"},{"name":"Get Listings Countries","id":"1566bce1-fe82-45ac-a00c-22b67a957717","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/countries","description":"

This request returns all active listings (where isDeleted is false),

\n

The return object will look as follows:

\n
[\n    \"Austria\",\n    \"Bulgaria\",\n    \"Zagreb\",\n    \"Milan\",\n    \"Cadiz\",\n    \"Barcelona\"\n]\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","listings","countries"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[],"variable":[]}},"response":[],"_postman_id":"1566bce1-fe82-45ac-a00c-22b67a957717"},{"name":"Get Listing Cities by Country","id":"8b18c187-0fde-4dfd-b48e-41bbcb15813e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/listings/citiesbycountry?country=Austria","description":"

This request returns all cities with listings in a country.

\n

Search Parameters

\n

The following search parameters can be passed to filter listings:

\n
    \n
  • country - string value i.e. Austria
    • \n
\n

The return object will look as follows:

\n
[\n    \"Vienna\",\n    \"Innsbruck\"\n]\n\n
\n","urlObject":{"protocol":"https","path":["api","v1","listings","citiesbycountry"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

The country name

\n","type":"text/plain"},"key":"country","value":"Austria"}],"variable":[]}},"response":[],"_postman_id":"8b18c187-0fde-4dfd-b48e-41bbcb15813e"},{"name":"Get Regions","id":"e9b8dad2-2449-4a1b-a2a7-c7f88c988c61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/regions?page=1&limit=25&access_token=","description":"

This request returns all regions that are used in the Listings API, i.e. regions that have listings assigned to them.

\n","urlObject":{"protocol":"https","path":["api","v1","regions"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

Page Number, starting at 1

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit, number of rows to return

\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"e9b8dad2-2449-4a1b-a2a7-c7f88c988c61"},{"name":"Get Region Detail","id":"414a9dae-8b12-4d18-9ada-ee432369bcde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/regions/1?access_token=","description":"

This request returns all regions that are used in the Listings API, i.e. regions that have listings assigned to them, and accepts the regionId as a route parameter.

\n","urlObject":{"protocol":"https","path":["api","v1","regions","1"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"414a9dae-8b12-4d18-9ada-ee432369bcde"},{"name":"Get Offices","id":"0249b8c1-1814-4be5-9e6f-f2d07ef09534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/offices?page=1&limit=25&access_token=","description":"

This request returns all offices that are used in the Listings API, i.e. offices that have listings assigned to them.

\n","urlObject":{"protocol":"https","path":["api","v1","offices"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

Page Number, starting at 1

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit, number of rows to return

\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"0249b8c1-1814-4be5-9e6f-f2d07ef09534"},{"name":"Get Office Detail","id":"639a7bcd-3812-4da3-a7f3-cf94638c24c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/offices/1?access_token=","description":"

This request returns office detail, using the office Id as a route parameter. This also returns listings associated with an office.

\n","urlObject":{"protocol":"https","path":["api","v1","offices","1"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"639a7bcd-3812-4da3-a7f3-cf94638c24c2"},{"name":"Get Agents","id":"bdc2fa29-cbf1-48f9-ae83-9d2117ce2aae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/agents?page=1&limit=25&access_token=","description":"

This request returns all agents that are used in the Listings API, i.e. agents that have listings assigned to them.

\n","urlObject":{"protocol":"https","path":["api","v1","agents"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

Page Number, starting at 1

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit, number of rows to return

\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"bdc2fa29-cbf1-48f9-ae83-9d2117ce2aae"},{"name":"Get Agent Detail","id":"b76d95cb-92d2-43d5-a27b-ef796188d3b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://listing-api-remaxeu.bwscloud.tech/api/v1/agents/1?access_token=","description":"

This request returns the detail of a specific agent with the agent Id passed as a route parameter.

\n","urlObject":{"protocol":"https","path":["api","v1","agents","1"],"host":["listing-api-remaxeu","bwscloud","tech"],"query":[{"description":{"content":"

OAuth Access Token

\n","type":"text/plain"},"key":"access_token","value":""}],"variable":[]}},"response":[],"_postman_id":"b76d95cb-92d2-43d5-a27b-ef796188d3b9"}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"001241a8-46c5-4d9e-a279-ff71cb558a6a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"25ef2c63-22e3-4263-b0ef-cfff95e517b0","type":"text/javascript","exec":[""]}}],"variable":[{"key":"jwt_token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImJ3c2FkbWluIiwiaWQiOjEsImlhdCI6MTcwMjkyNjQ5MSwiZXhwIjoxNzAyOTQwODkxfQ.wTzz-dOyKNBqg0-ptyJf3nJTI41649V2fcnqGCqLlUU"}]}