PropertyRadar

View Properties in Portfolio

Changed on Apr 24, 2024

List property and gnaf id's for an existing portfolio

get/v1/propertyradar/portfolio/{PortfolioId}

Request

Base URL
https://api.domain.com.au
Auth
- API key in header x-api-key
- or OAuth 2
  Authorization codehttps://auth.domain.com.au/v1/connect/authorize
  Client credentials
  Token URLhttps://auth.domain.com.au/v1/connect/token
  Scopesapi_propertyportfolio_read
TypeScript
https://skmtc.dev/domain/apis/domain-public-api/docs/v1/propertyradar/portfolio/:PortfolioId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

PortfolioIdstring required

Response

List of property and gnaf id's

PortfolioIdstring

Example response

{
  "PortfolioId": "PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1",
  "Properties": {
    "PropertyIds": [
      "AB-2872-NY",
      "RF-8884-AK"
    ],
    "GnafIds": [
      "GAVIC419677979",
      "GANSW710292212"
    ]
  }
}

Changes

Apr 24, 2024eee76e147314 Revision changes
- info
  endpoint added

Operation history