Skip to main content

Get-AtriaWorkSpaceList

SYNOPSIS​

Retrieves workspace lists from Atria.

SYNTAX​

Get-AtriaWorkSpaceList [<CommonParameters>]

Get-AtriaWorkSpaceList [-listId <Int>] [<CommonParameters>]

Get-AtriaWorkSpaceList [-filter <String>] [<CommonParameters>]

DESCRIPTION​

Retrieves workspace lists from the Atria API. You can use this function to:

  • Retrieve all workspace lists.
  • Retrieve a specific workspace list by specifying a listId.
  • Retrieve workspace lists matching a specified filter.

PARAMETERS​

  • listId <Int> (Optional)
    Retrieves a specific workspace list by its unique identifier.

  • filter <String> (Optional)
    Retrieves workspace lists matching the specified filter criteria.

  • <CommonParameters>
    Supports common parameters:
    Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable.

    More info: about_CommonParameters.

OUTPUTS​

Returns workspace lists retrieved from the Atria API as objects.

EXAMPLES​

Example 1​

PS> Get-AtriaWorkSpaceList

Retrieves all workspace lists from Atria.

Example 2​

PS> Get-AtriaWorkSpaceList -listId 456

Retrieves the workspace list with the ID 456.

Example 3​

PS> Get-AtriaWorkSpaceList -filter "Name eq 'Approved Apps'"

Retrieves workspace lists where the Name matches "Approved Apps".

NOTES​

Ensure you've authenticated using Connect-AtriaApi before invoking this function.