Get overview workspaces

get

https://api.controlup.com/daas-iq/v1/cloud/overview/workspaces

Returns a paginated list of AVD workspaces with metrics including associated application groups count, host pools, and session statistics.
Workspaces represent the top-level user experience - they group Application Groups that users see in their Remote Desktop client.

Query Params

Provider

string

enum

Filter by cloud provider. Currently only Azure is supported.

Allowed:

SubscriptionId

uuid

Filter by cloud subscription (internal ID).

RegionId

string

length ≤ 100

Filter by Azure region code (e.g., 'eastus', 'westeurope').

ResourceGroupId

uuid

Filter by resource group (internal ID).

WorkspaceId

uuid

Filter by workspace (internal ID).

ApplicationGroupId

uuid

Filter by application group (internal ID).

HostPoolId

uuid

Filter by host pool (internal ID).

SessionHostId

uuid

Filter by session host (internal ID).

UserSessionId

uuid

Filter by user session (internal ID).

ImageId

uuid

Filter by image (internal ID).

MasterImageId

uuid

Filter by master image (internal ID).

Page

int32

1 to 2147483647

The page number to retrieve (1-based). Default: 1.

PageSize

int32

1 to 100

The number of items per page (1-100). Default: 50.

Responses

500

Internal server error.

200Successfully retrieved workspaces.

400Bad request. Invalid pagination parameters.

401Unauthorized. User is not authenticated.

403Forbidden. User does not have access to this organization.