Get-Contacts
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-Contacts
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Summary
Retrieves a collection of contact field cache objects.
Get-Contacts
-Top
-Skip
-Filter
-OrderByReturns a collection object with the following properties:
Property | Type | Notes |
|---|---|---|
Collection | Collection of contact field cache objects | The collection of entries retrieved after top, skip, filter, and order by parameters were applied. |
Top | Int32 | The top parameter value that was used. Useful while paging data. |
Skip | Int32 | The skip parameter value that was used. Useful while paging data. |
TotalCount | Int32 | The total count of records available after any filtering was applied. Useful while paging data. |
Field Cache Objects
Field cache objects cannot be used directly for updating an object using a
Set-*command. Instead, you will need to retrieve the object you intend to update directly using aGet-*command, modify the properties you want to update, and then save that object back using aSet-*command.
Parameters
Parameter | Type | Required? | Notes |
|---|---|---|---|
Top | Int32 | No, Defaults to 40 | Total number of entries to retrieve. Max is 1000. |
Skip | Int32 | No, Defaults to 0 | How many entries should be skipped within the collection. Used for paging the results. |
Filter | String | No | An OData 4 string that can be used for filtering the collection. |
OrderBy | String | No | An OData 4 string that can be used for sorting the collection by specific fields. |
Examples
Get a collection of contacts
# Retrieve one record from the collection, since we're only interested in the total count.
$collectionWrapper = Get-Contacts -Top 1
Write-Output "There are $($collectionWrapper.TotalCount) contact(s) in the workspace"Results of executing the script:
There are 786 contact(s) in the workspace