Listing API

For Link-Out advanced or API integrations, listings can be individually added to flow through the listing API.

This allows a just-in-time listing creation and publishing, without needing to wait for a feed synchronisation cycle to complete.

The Listing API requires authentication, using the Client ID and the API Key provided by your Flow account manager. Once authenticated, a listing can be created on the process-listing endpoint

Authentication

GET https://api.flowliving.com/auth/access-key/publickey?organisationId={{Client ID}}&apiKey={{API Key}}&requestType=propertyAPI

This endpoint will return the authentication token to be used in the following listing creation calls

Response

{
    "accessToken": "…"
}

Create a new listing

POST https://api.flowliving.com/v3/properties-api/process-listing?organisation={{Client ID}}

The listing API accepts a POST request with the body structured according to the standard listing used in the feed configuration

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <accessToken>

Accept-version

v1

Response

The below body example uses a Flow CSV example with a property listing structure

{
  "home_listing_id": "E322844606",
  "name": "Apartement for Sale",
  "availability": "for_sale",
  "num_beds": "2",
  "num_baths": "0",
  "num_parkings": "0",
  "land_area": "100",
  "description": "…",
  "address_line1": "1 Apple Street",
  "address_city": "Berlin",
  "address_region": "3",
  "address_country": "",
  "address_postal_code": "10557",
  "latitude": "52.52534",
  "longitude": "13.36666",
  "image_urls": "…",
  "price": "$250k NEG",
  "search_price": "250000",
  "url": "…",
  "property_type": "HOUSE",
  "listing_tier": "null",
  "office_id": "113592539",
  "office_name": "Head Office Name",
  "office_logo": "…",
  "agent_id": "113592538",
  "agent_name": "Agent Name",
  "agent_image": "…",
  "agent_phone": "",
  "agent_email": "[email protected]",
  "listingType": "sale",
  "propertyType": "house"
}

Response

"Listing: 67111f6d0a412000121cdb61 was updated successfully"

Last updated