Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
titleget
https://ws.icnea.net/analytics/listings/?usr=a1b2c3d4e5&client_id=1234

Use this endpoint to retrieve all listings for a given property manager.

...

QUERY PARAMS

...

Parameter

...

Description

usr

string required

API_key for your company, provided by Icnea.

client_id

integer required

Property Manager ID

exclude_active

boolean

Set to true to return only unlisted listings. Default is false.

...

RESPONSES

Status
colourGreen
title200

Code Block
languagejson
{  
  "analytics_listings_response": {
    "listings": [
      {
        "listing_id": 12341001,
        "active": "true"
      }, {
        "listing_id": 12341002,
        "active": "false"
      }
    ] 
  }
}

Field

Type

Description

listing_id

integer

Unique ID of the property. 5-digits (in testing accounts) or 8-digits (in real accounts).

active

boolean

True or false. If false, the listing is unlisted and can’t be used.

Status
colourRed
title400

Code Block
languagejson
{  
  "analytics_listings_response": {
    "error_code": "",
    "error_message": ""
  }
}

...