Get paginated list of all portfolio

  • Published on Jul 21, 2025
  • 1 minute(s) read
Prev Next
Get
/api/v2/portfolios
Security
HTTP
Type bearer
Query parameters
timezone
string
ExampleAsia/Kolkata
name
string

The name of an portfolio to filter

size
integer

The number of records to return per page

Default25
page
integer

The page number. The page number start from 1

Default1
sort
array of string

Sorting criteria in the format: field:asc|desc, field defaults to whenCreated and direction defaults to DESC. Example fields are: ['name', 'whenCreated', 'whenChanged']

DefaultwhenCreated:DESC
Example[ "name:asc" ]
_fields
string

Add the specified fields in the site responce object. Available values are: ['userCount','groupCount','deviceCount']

Responses
200

A list of all portfolios

Expand All
object
authorization
boolean
data
object
page
integer
results
Array of object (PortfolioDetails)
object
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
size
integer
totalCount
integer
totalPage
integer
error_code
integer
error_message
string
error_status
boolean
Examplefalse
401

Unauthorized

object
error_code
integer
error_message
string
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