(PowerShell) Outlook List Contacts

See more Outlook Contact Examples

List Outlook Contacts

For more information, see https://docs.microsoft.com/en-us/graph/api/user-list-contacts?view=graph-rest-1.0&tabs=http

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

# Use your previously obtained access token here: Get Outlook Contacts OAuth2 Access Token (Azure AD v2.0 Endpoint).

$jsonToken = New-Object Chilkat.JsonObject
$success = $jsonToken.LoadFile("qa_data/tokens/outlookContacts.json")
if ($success -eq $false) {
    $($jsonToken.LastErrorText)
    exit
}

$http.AuthToken = $jsonToken.StringOf("access_token")

# Send the following GET:

# GET https://graph.microsoft.com/v1.0/me/contacts
$sbJson = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://graph.microsoft.com/v1.0/me/contacts",$sbJson)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$statusCode = $http.LastStatus
$("Response status code = " + $statusCode)

if ($statusCode -ne 200) {
    $($sbJson.GetAsString())
    $("Failed.")
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbJson)
$jResp.EmitCompact = $false
$($jResp.Emit())

# Sample output:

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('4ee732c3-322e-4a6b-b729-2fd1eb5c6004')/contacts",
#   "value": [
#     {
#       "@odata.etag": "W/\"EQAAABYAAABUcG0qWqkmQYqWLHQataQxAAD0iYfT\"",
#       "id": "AAMkADYzZWE3YmZmLWU0YzgtNGNkZC04MGE1LWFiYTFlNTRlY2QwYQBGAAAAAAAu7cUXL5YOTrdsUIw7-v8FBwBUcG0qWqkmQYqWLHQataQxAAAAAAEOAABUcG0qWqkmQYqWLHQataQxAAD0sxexAAA=",
#       "createdDateTime": "2021-06-29T16:32:05Z",
#       "lastModifiedDateTime": "2021-06-29T16:32:06Z",
#       "changeKey": "EQAAABYAAABUcG0qWqkmQYqWLHQataQxAAD0iYfT",
#       "categories": [
#       ],
#       "parentFolderId": "AAMkADYzZWE3YmZmLWU0YzgtNGNkZC04MGE1LWFiYTFlNTRlY2QwYQAuAAAAAAAu7cUXL5YOTrdsUIw7-v8FAQBUcG0qWqkmQYqWLHQataQxAAAAAAEOAAA=",
#       "birthday": null,
#       "fileAs": "",
#       "displayName": "Pavel Bansky",
#       "givenName": "Pavel",
#       "initials": null,
#       "middleName": null,
#       "nickName": null,
#       "surname": "Bansky",
#       "title": null,
#       "yomiGivenName": null,
#       "yomiSurname": null,
#       "yomiCompanyName": null,
#       "generation": null,
#       "imAddresses": [
#       ],
#       "jobTitle": null,
#       "companyName": null,
#       "department": null,
#       "officeLocation": null,
#       "profession": null,
#       "businessHomePage": null,
#       "assistantName": null,
#       "manager": null,
#       "homePhones": [
#       ],
#       "mobilePhone": null,
#       "businessPhones": [
#         "+1 732 555 0102"
#       ],
#       "spouseName": null,
#       "personalNotes": "",
#       "children": [
#       ],
#       "emailAddresses": [
#         {
#           "name": "Pavel Bansky",
#           "address": "pavelb@fabrikam.onmicrosoft.com"
#         }
#       ],
#       "homeAddress": {},
#       "businessAddress": {},
#       "otherAddress": {}
#     },
# ...
#   ]
# }

$odata_context = $jResp.StringOf("`"@odata.context`"")
$i = 0
$count_i = $jResp.SizeOfArray("value")
while ($i -lt $count_i) {
    $jResp.I = $i
    $odata_etag = $jResp.StringOf("value[i].`"@odata.etag`"")
    $id = $jResp.StringOf("value[i].id")
    $createdDateTime = $jResp.StringOf("value[i].createdDateTime")
    $lastModifiedDateTime = $jResp.StringOf("value[i].lastModifiedDateTime")
    $changeKey = $jResp.StringOf("value[i].changeKey")
    $parentFolderId = $jResp.StringOf("value[i].parentFolderId")
    $birthday = $jResp.StringOf("value[i].birthday")
    $fileAs = $jResp.StringOf("value[i].fileAs")
    $displayName = $jResp.StringOf("value[i].displayName")
    $givenName = $jResp.StringOf("value[i].givenName")
    $initials = $jResp.StringOf("value[i].initials")
    $middleName = $jResp.StringOf("value[i].middleName")
    $nickName = $jResp.StringOf("value[i].nickName")
    $surname = $jResp.StringOf("value[i].surname")
    $title = $jResp.StringOf("value[i].title")
    $yomiGivenName = $jResp.StringOf("value[i].yomiGivenName")
    $yomiSurname = $jResp.StringOf("value[i].yomiSurname")
    $yomiCompanyName = $jResp.StringOf("value[i].yomiCompanyName")
    $generation = $jResp.StringOf("value[i].generation")
    $jobTitle = $jResp.StringOf("value[i].jobTitle")
    $companyName = $jResp.StringOf("value[i].companyName")
    $department = $jResp.StringOf("value[i].department")
    $officeLocation = $jResp.StringOf("value[i].officeLocation")
    $profession = $jResp.StringOf("value[i].profession")
    $businessHomePage = $jResp.StringOf("value[i].businessHomePage")
    $assistantName = $jResp.StringOf("value[i].assistantName")
    $manager = $jResp.StringOf("value[i].manager")
    $mobilePhone = $jResp.StringOf("value[i].mobilePhone")
    $spouseName = $jResp.StringOf("value[i].spouseName")
    $personalNotes = $jResp.StringOf("value[i].personalNotes")
    $j = 0
    $count_j = $jResp.SizeOfArray("value[i].categories")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("value[i].imAddresses")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("value[i].homePhones")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("value[i].businessPhones")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $strVal = $jResp.StringOf("value[i].businessPhones[j]")
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("value[i].children")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("value[i].emailAddresses")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $name = $jResp.StringOf("value[i].emailAddresses[j].name")
        $address = $jResp.StringOf("value[i].emailAddresses[j].address")
        $j = $j + 1
    }

    $i = $i + 1
}