Retrieves contact segments from the Brevo API.

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

The Get-BrevoContactSegment function retrieves contact segments from the Brevo API. It allows you to specify the number of results per page, the starting index for pagination, and the sort order of the results.

Get-BrevoContactSegment -limit 20 -offset 0 -sort "asc"

Retrieves the first 20 contact segments sorted in ascending order.

Get-BrevoContactSegment -limit 50 -offset 100

Retrieves 50 contact segments starting from the 101st record, sorted in descending order.

The number of results returned per page. The default is 10, and the maximum is 50.

Type: Int32
Parameter Sets: (All)
Aliases:

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

The index of the first document in the page (starting with 0). For example, if the limit is 50 and you want to retrieve page 2, then offset=50.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
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 the ascending ("asc") or descending ("desc") order of record creation. The default order is descending if this parameter is not specified.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: Desc
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.