---
title: "List Portfolios"
method: GET
path: "/v1/propertyradar/portfoliosummary"
tags: ["PropertyRadar"]
---

# List Portfolios

`GET /v1/propertyradar/portfoliosummary`

## Request

- Base URL: `https://api.domain.com.au`
- URL: `https://api.domain.com.au/v1/propertyradar/portfoliosummary`
- Auth: one of:
  - API key in header `x-api-key`
  - OAuth 2
    - Authorization code: `https://auth.domain.com.au/v1/connect/authorize`
    - Client credentials
    - Token URL: `https://auth.domain.com.au/v1/connect/token` scopes: `api_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)

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

## Response `200`

List of portfolios

- PropertyActivityAPIV1PortfolioList
  - `Portfolios` object[]
    - `PortfolioId` string
    - `PropertyIdCount` integer: Total number of property ids defined
    - `GnafIdCount` integer: Total number of gnaf ids defined

## Other responses

- `400`: Bad request
- `500`: Unexpected error

## Changes

- **2024-04-24** `eee76e147314`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/domain/apis/domain-public-api/changes/v1/propertyradar/portfoliosummary/get.md)

---

[API](https://skmtc.dev/domain/apis/domain-public-api.md) - [All operations](https://skmtc.dev/domain/apis/domain-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/domain/apis/domain-public-api/revisions/133015c6842c?raw)