---
title: "View Properties in Portfolio - Detailed"
method: GET
path: "/v1/propertyradar/portfolio/{PortfolioId}/properties"
tags: ["PropertyRadar"]
---

# View Properties in Portfolio - Detailed

`GET /v1/propertyradar/portfolio/{PortfolioId}/properties`

## Request

- Base URL: `https://api.domain.com.au`
- URL: `https://api.domain.com.au/v1/propertyradar/portfolio/{PortfolioId}/properties`
- 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/portfolio/:PortfolioId/properties/get.ts> (a function with typed inputs; its response is checked against the schema)

List property and gnaf id's with details for an existing portfolio, along with market status and last listed information. Results are returned one page at a time, with a default page size of 500000 records. Records are returned in alphabetical order, with Property ID's first followed by GNAF ID's.For PageSize greater than 10000, please don't use Domain Portal UI

## Path parameters

- `PortfolioId` string, required

## Query parameters

- `Page` integer
- `PageSize` integer

## Response `200`

List of property and gnaf id's

- object
  - `Data` object
    - `PortfolioId` string
    - `Properties` object
      - `PropertyIds` object[]
        - `PropertyId` string
        - `MarketStatus` 'on-market' | 'off-market' | 'null', nullable: Whether the property is currently on the market. "null" = unknown
        - `SaleRentFlag` 'sale' | 'rent' | 'null', nullable: if MarketStatus = "on-market", then whether the property is for sale or rent, otherwise "null"
        - `LastListedDate` string, date, nullable: if MarketStatus = "on-market", then the date when the property was listed for sale or rent, otherwise "null"
      - `GnafIds` object[]
        - `GnafId` string
        - `MarketStatus` 'on-market' | 'off-market' | 'null', nullable: Whether the property is currently on the market. null = unknown
        - `SaleRentFlag` 'sale' | 'rent' | 'null', nullable: if MarketStatus = "on-market", then whether the property is for sale or rent, otherwise "null"
        - `LastListedDate` string, date, nullable: if MarketStatus = "on-market", then the date when the property was listed for sale or rent, otherwise "null"
  - `Pagination` object
    - `Total` integer: The total number of property and gnaf id's in the portfolio
    - `Page` integer: Current page being returned
    - `PageSize` integer: The maximum number of property + gnaf id's per page
    - `TotalPages` integer: The total number of available pages of data
    - `PrevPage` string, nullable: A link to the previous page of data (if applicable)
    - `NextPage` string, nullable: A link to the next page of data (if applicable)

## Other responses

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

## Changes

- **2024-07-24** `24584824570f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/domain/apis/domain-public-api/changes/v1/propertyradar/portfolio/:PortfolioId/properties/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)