Skip to main content

Get-IMAlbum

SYNOPSIS​

Retrieves Immich albums

SYNTAX​

list (Default)​

Get-IMAlbum [-Session <ImmichSession>] [-AssetId <String>] [-IncludeAssets] [-Shared <Boolean>]
 [-Name <String>] [-SearchString <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id​

Get-IMAlbum [-Session <ImmichSession>] -AlbumId <String> [-IncludeAssets] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Retrieves one or more albums from the Immich server. Can retrieve all albums, specific albums by ID, albums containing specific assets, or filter albums by name or shared status.

EXAMPLES​

EXAMPLE 1​

Get-IMAlbum

Retrieves all albums for the current user.

EXAMPLE 2​

Get-IMAlbum -AlbumId 'bde7ceba-f301-4e9e-87a2-163937a2a3db'

Retrieves a specific album by its ID.

EXAMPLE 3​

Get-IMAlbum -Name 'Family Vacation'

Retrieves the album with the exact name 'Family Vacation'.

EXAMPLE 4​

Get-IMAlbum -SearchString 'vacation*' -IncludeAssets

Retrieves all albums with names starting with 'vacation' and includes their assets.

EXAMPLE 5​

Get-IMAlbum -Shared:$true

Retrieves only albums that are shared with other users.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AlbumId​

The UUID of a specific album to retrieve. Accepts pipeline input.

Type: String
Parameter Sets: id
Aliases: Id

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-AssetId​

Only returns albums that contain the specified asset UUID.

Type: String
Parameter Sets: list
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeAssets​

Specifies whether to include assets as part of the returned album objects. By default, assets are not included for performance.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Shared​

Specifies whether to return shared albums. If not specified, returns both shared and non-shared albums.

Type: Boolean
Parameter Sets: list
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Name​

Specifies the exact name of an album to retrieve.

Type: String
Parameter Sets: list
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SearchString​

Specifies a string to search for in album names. Supports wildcards for pattern matching.

Type: String
Parameter Sets: list
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github