Portfolios

Method	Path	Description
GET	/external/portfolios/	List root portfolios
GET	/external/portfolios/{id}/	Retrieve a portfolio with its direct child portfolios and properties

Portfolios can't be created or changed through the API. Manage them in the Telescope app.

List root portfolios

GET /external/portfolios/

Returns only the top level of your portfolio tree, paginated like the property list.

{
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "b2a4c7e0-1d2f-4f39-8e2a-5c6d7e8f9a01",
      "name": "Norway",
      "internal_reference_id": "",
      "updated_at": "2026-08-12T07:30:00.000000Z"
    }
  ]
}

Field	Type	Description
id	UUID	Telescope's identifier for the portfolio. Use it as portfolio_id when creating properties.
name	text	Portfolio name.
internal_reference_id	text	Your own reference for the portfolio. Empty string when not set.
updated_at	timestamp	When the portfolio last changed.

Retrieve a portfolio

GET /external/portfolios/{id}/

Returns the portfolio with its parent and everything directly inside it. To walk the whole tree, request each child in turn.

{
  "id": "e5f6a7b8-0c1d-4e2f-9a3b-4c5d6e7f8a90",
  "name": "Oslo",
  "internal_reference_id": "REG-OSL",
  "parent_id": "b2a4c7e0-1d2f-4f39-8e2a-5c6d7e8f9a01",
  "updated_at": "2026-08-12T07:31:00.000000Z",
  "portfolios": [
    {
      "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Office",
      "internal_reference_id": "",
      "updated_at": "2026-08-12T07:32:00.000000Z"
    }
  ],
  "properties": [
    {
      "id": "3f6c1a52-8a1e-4c3e-9a57-0b1f6f0c2d11",
      "internal_reference_id": "P-1001",
      "name": "Storgata 1",
      "value_estimate": 85000000,
      "portfolio_id": "e5f6a7b8-0c1d-4e2f-9a3b-4c5d6e7f8a90",
      "address": "Storgata 1",
      "postal_code": "0155",
      "postal_area": "Oslo",
      "matrikkelnummer": "0301-208/101/0/0",
      "created_at": "2026-03-02T09:14:07.512345Z",
      "updated_at": "2026-09-30T12:01:44.104221Z"
    }
  ]
}

Field	Type	Description
id, name, internal_reference_id, updated_at		As in the list.
parent_id	UUID or null	The parent portfolio, or null for a root portfolio.
portfolios	list	Child portfolios directly inside this one, sorted by name, with the same fields as the list.
properties	list	Properties directly inside this portfolio, sorted by name.

The properties here are a short form, without country and without results. Use GET /external/properties/{id}/ for the full property, or list properties and group them by portfolio_id.

Neither list is paginated. Properties in child portfolios aren't included.