e Get-TdBranch | Welcome to TOPdeskPS

Main | Command Reference | Quick Start

Welcome to TOPdeskPS

PowerShell module to interact with the TOPdesk REST Api

Get-TdBranch

SYNOPSIS

Gets Branches

SYNTAX

Get-TdBranch [[-Name] <String>] [-Archived] [<CommonParameters>]

DESCRIPTION

Gets Branches

EXAMPLES

EXAMPLE 1

Get-TdBranch

Gets Branches

EXAMPLE 2

Get-TdBranch 'Main Office'

Returns the ‘Main Office’ branch

PARAMETERS

-Name

Name of the branch that you want returned.Wildcards are supported. Default value is ‘*’

Type: String
Parameter Sets: (All)
Aliases:

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

-Archived

Whether to retrieve archived incidents. Doesn’t return archived branches by default.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES