Retrieves contact folder(s) from the Brevo API.

Get-BrevoContactFolder [-None] [-limit <Int32>] [-offset <Int32>] [-sort <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-BrevoContactFolder [-folderId <Int32>] [-None] [-limit <Int32>] [-offset <Int32>] [-sort <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-BrevoContactFolder [-Name <String>] [-None] [-limit <Int32>] [-offset <Int32>] [-sort <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

The Get-BrevoContactFolder function retrieves one or more contact folders from the Brevo API. You can retrieve a specific folder by its ID, filter by folder name, or list folders with optional pagination and sorting.

Get-BrevoContactFolder -folderId 123

Retrieves the contact folder with ID 123.

Get-BrevoContactFolder -limit 20 -offset 10 -sort asc

Retrieves a paginated list of contact folders, 20 per page, skipping the first 10, sorted in ascending order.

Get-BrevoContactFolder -Name "Marketing"

Retrieves contact folders with the name "Marketing".

The ID of the folder to retrieve. If specified, retrieves a single folder by its ID.

Type: Int32
Parameter Sets: ByFolderId
Aliases:

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

The number of documents per page (0 to 50). Defaults to 10 if not specified.

Type: Int32
Parameter Sets: (All)
Aliases:

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

The name of the folder to retrieve. If specified, filters the results to folders matching the given name.

Type: String
Parameter Sets: ByFolderName
Aliases:

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

Reserved for future use. Currently has no effect.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

The number of documents to skip before starting to collect the result set. Defaults to 0.

Type: Int32
Parameter Sets: (All)
Aliases:

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

{{ 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

Sorts the results in ascending ("asc") or descending ("desc") order of record creation. The default order is "desc".

Type: String
Parameter Sets: (All)
Aliases:

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

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