Public/Get-ZomentumContacts.ps1
|
function Get-ZomentumContacts { <# .SYNOPSIS Gets Contacts from the Zomentum API. .DESCRIPTION Retrieves contacts from the Zomentum API - supports a variety of filtering parameters. .OUTPUTS A powershell object containing the response. #> [CmdletBinding()] Param( # Contact ID for retrieving a single contact [Parameter( ParameterSetName = 'Single', Mandatory = $True )] [string]$ContactID, # An Object containing filter variables [Parameter( ParameterSetName = 'Multiple')] [PSCustomObject]$Filters, # The Child entities to include with the records. [Parameter( ParameterSetName = 'Single')] [Parameter( ParameterSetName = 'Multiple')] [string]$IncludeChildren ) $QueryString = '' if ($ContactID) { if ($IncludeChildren){ $QueryString = $QueryString + "?included_child_entities=$IncludeChildren" } Write-Verbose "Fetching Single Contact" $Contacts = Invoke-ZomentumRequest -method get -resource "client/users/$ContactID" -QueryString $QueryString } else { if ($IncludeChildren){ $QueryString = $QueryString + "&included_child_entities=$IncludeChildren" } Write-Verbose "Fetching Multiple Contacts" $Contacts = Invoke-ZomentumRequest -method get -resource "client/users" -Filters $Filters -MultiFetch -QueryString $QueryString } return $Contacts } |