Get-ITGlueContact
SYNOPSIS
List or show all contacts
SYNTAX
Index (Default)
Get-ITGlueContact [-OrganizationID <Int64>] [-FilterID <Int64>] [-FilterFirstName <String>]
[-FilterLastName <String>] [-FilterTitle <String>] [-FilterContactTypeID <Int64>] [-FilterImportant <String>]
[-FilterPrimaryEmail <String>] [-FilterOrganizationID <Int64>] [-FilterPsaIntegrationType <String>]
[-Sort <String>] [-PageNumber <Int64>] [-PageSize <Int32>] [-Include <Object>] [-AllResults]
[<CommonParameters>]
Show
Get-ITGlueContact [-OrganizationID <Int64>] [-FilterOrganizationID <Int64>] -ID <Int64> [-Include <Object>]
[<CommonParameters>]
Index_PSA
Get-ITGlueContact [-OrganizationID <Int64>] [-FilterID <Int64>] [-FilterFirstName <String>]
[-FilterLastName <String>] [-FilterTitle <String>] [-FilterContactTypeID <Int64>] [-FilterImportant <String>]
[-FilterPrimaryEmail <String>] [-FilterOrganizationID <Int64>] [-FilterPsaID <String>]
-FilterPsaIntegrationType <String> [-Sort <String>] [-PageNumber <Int64>] [-PageSize <Int32>]
[-Include <Object>] [-AllResults] [<CommonParameters>]
DESCRIPTION
The Get-ITGlueContact cmdlet lists all or a single contact(s) from your account or a defined organization
This function can call the following endpoints: Index = /contacts /organizations/:organization_id/relationships/contacts
Show = /contacts/:id
/organizations/:organization_id/relationships/contacts/:id
EXAMPLES
EXAMPLE 1
Get-ITGlueContact
Returns the first 50 contacts from your ITGlue account
EXAMPLE 2
Get-ITGlueContact -OrganizationID 8765309
Returns the first 50 contacts from the defined organization
EXAMPLE 3
Get-ITGlueContact -PageNumber 2 -PageSize 10
Returns the first 10 results from the second page for contacts in your ITGlue account
PARAMETERS
-OrganizationID
A valid organization Id in your account
Type: Int64
Parameter Sets: (All)
Aliases: org_id, organization_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterID
Filter by contact id
Type: Int64
Parameter Sets: Index, Index_PSA
Aliases: filter_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterFirstName
Filter by contact first name
Type: String
Parameter Sets: Index, Index_PSA
Aliases: filter_first_name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterLastName
Filter by contact last name
Type: String
Parameter Sets: Index, Index_PSA
Aliases: filter_last_name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterTitle
Filter by contact title
Type: String
Parameter Sets: Index, Index_PSA
Aliases: filter_title
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterContactTypeID
Filter by contact type id
Type: Int64
Parameter Sets: Index, Index_PSA
Aliases: filter_contract_type_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterImportant
Filter by if contact is important
A users important field in ITGlue can sometimes be null which will cause this parameter to return incomplete information
Type: String
Parameter Sets: Index, Index_PSA
Aliases: filter_important
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterPrimaryEmail
Filter by contact primary email address
Type: String
Parameter Sets: Index, Index_PSA
Aliases: filter_primary_email
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterOrganizationID
Filter by an organization ID
Type: Int64
Parameter Sets: (All)
Aliases: filter_organization_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterPsaID
Filter by a PSA id
This must be accompanied by the filter for FilterPsaIntegrationType
Type: String
Parameter Sets: Index_PSA
Aliases: filter_psa_id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterPsaIntegrationType
Filter by a PSA integration type
Allowed values: ‘manage’, ‘autotask’, ‘tigerpaw’, ‘kaseya-bms’, ‘pulseway-psa’, ‘vorex’
Type: String
Parameter Sets: Index
Aliases: filter_psa_integration_type
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: Index_PSA
Aliases: filter_psa_integration_type
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Sort
Sort results by a defined value
Allowed values: ‘first_name’, ‘last_name’, ‘id’, ‘created_at’, ‘updated_at’, ‘-first_name’, ‘-last_name’, ‘-id’, ‘-created_at’, ‘-updated_at’
Type: String
Parameter Sets: Index, Index_PSA
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PageNumber
Return results starting from the defined number
Type: Int64
Parameter Sets: Index, Index_PSA
Aliases: page_number
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
Number of results to return per page
The maximum number of page results that can be requested is 1000
Type: Int32
Parameter Sets: Index, Index_PSA
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ID
Define a contact id
Type: Int64
Parameter Sets: Show
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Include
Include specified assets
Allowed values (Shared): adapters_resources, attachments, distinct_remote_contacts, group_resource_accesses, location, passwords, resource_fields, tickets, user_resource_accesses
Allowed values (Index-Unique): N/A
Allowed values (Show-Unique): recent_versions, related_items, authorized_users
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AllResults
Returns all items from an endpoint
This can be used in unison with -PageSize to limit the number of sequential requests to the API
Type: SwitchParameter
Parameter Sets: Index, Index_PSA
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.
INPUTS
OUTPUTS
NOTES
N/A
RELATED LINKS
https://celerium.github.io/ITGlue-PowerShellWrapper/site/Contacts/Get-ITGlueContact.html