PropertyRadar

List Portfolios

Changed on Apr 24, 2024

List all portfolios for the customer with a count of associated property and gnaf id's

get/v1/propertyradar/portfoliosummary

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/portfoliosummary/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

List of portfolios

Example response

{
  "Portfolios": [
    {
      "PortfolioId": "PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1"
    }
  ]
}

Changes

Apr 24, 2024eee76e147314 Revision changes
- info
  endpoint added

Operation history