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

# View Properties in Portfolio

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

## Request

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

List property and gnaf id's for an existing portfolio

## Path parameters

- `PortfolioId` string, required

## Response `200`

List of property and gnaf id's

- object
  - `PortfolioId` string
  - `Properties` object
    - `PropertyIds` string[]
    - `GnafIds` string[]

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `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/portfolio/:PortfolioId/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)