Skip to main content
GET
Get Portfolio Groups

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string | null

The query param to search by portfolio group name. If provided, only groups with names containing this term (case-insensitive) will be returned.

limit
integer
default:10

Maximum number of records to return in a single page. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
offset
integer | null

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Required range: x >= 0
cursor
string | null

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

Response

Response

id
string<uuid>
required

The unique identifier of the portfolio group.

name
string
required

The name of the portfolio group.

items_count
integer
required

The number of items in this portfolio group.

created_at
string<date-time>
required

When the portfolio group was created.

updated_at
string<date-time> | null
required

When the portfolio group was last updated.

console_url
string
required
read-only