Skip to main content

Get-IMMapMarker

SYNOPSIS​

Retrieves map markers for assets with GPS coordinates.

SYNTAX​

Get-IMMapMarker [[-Session] <ImmichSession>] [[-CreatedAfter] <DateTime>] [[-CreatedBefore] <DateTime>]
 [[-IsArchived] <Boolean>] [[-IsFavorite] <Boolean>] [[-WithPartners] <Boolean>]
 [[-WithSharedAlbums] <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

The Get-IMMapMarker function retrieves map markers that represent the geographic locations of assets in Immich. Map markers are created from assets that contain GPS metadata and provide a visual representation for map-based navigation and asset discovery.

The function supports various filters to refine the returned markers based on creation dates, archive status, favorites, partner sharing, and shared albums. This enables targeted retrieval of location data for specific asset collections.

EXAMPLES​

EXAMPLE 1​

Get-IMMapMarker

Retrieves all available map markers for assets with GPS coordinates.

EXAMPLE 2​

Get-IMMapMarker -IsFavorite $true

Retrieves map markers only for assets marked as favorites.

EXAMPLE 3​

Get-IMMapMarker -CreatedAfter (Get-Date).AddMonths(-6) -IsArchived $false

Gets map markers for non-archived assets created in the last 6 months.

EXAMPLE 4​

Get-IMMapMarker -WithPartners $true -WithSharedAlbums $true

Retrieves map markers including both partner-shared and shared album assets.

PARAMETERS​

-Session​

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

-Session $Session

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-CreatedAfter​

Filters map markers to include only those created after the specified date and time. Use this to focus on recently added location data or specific time periods.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-CreatedBefore​

Filters map markers to include only those created before the specified date and time. Useful for historical analysis or excluding recent additions.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-IsArchived​

Filters map markers based on archive status. Set to $true to include only archived assets, $false to exclude archived assets, or omit to include all assets regardless of archive status.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-IsFavorite​

Filters map markers to include only favorite assets when set to $true, or exclude favorites when set to $false. Omit to include all assets regardless of favorite status.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-WithPartners​

Controls whether to include map markers for assets shared with partners. Set to $true to include partner-shared assets, $false to exclude them.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-WithSharedAlbums​

Controls whether to include map markers for assets in shared albums. Set to $true to include shared album assets, $false to exclude them.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
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​

Map markers are generated from assets that contain valid GPS coordinates in their metadata. The density and distribution of markers depend on the geographic diversity of your asset collection.

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