Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 9 Next »

GET https://ws.icnea.net/analytics/listings/

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


QUERY PARAMS

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

200

{  
  "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.

400

{  
  "analytics_listings_response": {
    "error_code": "",
    "error_message": ""
  }
}

Field

Type

Description

error_code

string

Icnea internal error_id to help with debugging.

error_message

string

Human readable description of error.

  • No labels