Get portfolio by ID

  • Published on Jul 21, 2025
  • 1 minute(s) read
Prev Next
Get
/api/v2/portfolios/{portfolioId}
Security
HTTP
Type bearer
Path parameters
portfolioId
stringRequired

The ID of the portfolio to get

Query parameters
timezone
string

The timezone to use for the response

ExampleUTC
Responses
200

Get a portfolio by ID

Expand All
object
authorization
boolean
data
object (PortfolioDetails)
description
string
deviceCount
integer
groupCount
integer
id
string
name
string
sites
Array of object
object
id
string
name
string
userCount
integer
whenChanged
string
whenCreated
string
error_code
integer
error_message
string
error_status
boolean
Examplefalse
401

Unauthorized

object
error_code
integer
error_message
string
error_status
boolean
404

Not Found

object
authorization
boolean
data
Array of string
Example[]
string
error_code
integer | null
error_message
string | null
error_status
boolean
500

Could not get portfolio - Internal Server Error

object
authorization
boolean
data
Array of string
Example[]
string
error_code
integer | null
error_message
string | null
error_status
boolean