Tcl Dynamics CRM: Get an Account's Contacts

Back to Index

Returns the full name, email address, and phone number for each of an account's contacts. This example gets the contacts for the Coho Winery account (accountid = b0a19cdd-88df-e311-b8e5-6c3be5a8b200).

Documentation: https://docs.microsoft.com/en-us/dynamics365/customer-engagement/web-api/contact?view=dynamics-ce-odata-9

CURL Command

curl -X GET https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/contacts \
  -H "Accept: application/json" \
  -H "OData-MaxVersion: 4.0"  \
  -H "OData-Version: 4.0" \
  -d "$select=fullname,emailaddress1,telephone1" \
  -d "$filter=_parentcustomerid_value eq b0a19cdd-88df-e311-b8e5-6c3be5a8b200" \
  -H "Authorization: Bearer DYNAMICS_CRM_ACCESS_TOKEN"

Tcl Example

load ./chilkat.dll

set rest [new_CkRest]

#  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/contacts
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "my-dynamics-domain.api.crm.dynamics.com" $port $bTls $bAutoReconnect]
if {[expr $success != 1]} then {
    puts "ConnectFailReason: [CkRest_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

CkRest_AddQueryParam $rest "$select" "fullname,emailaddress1,telephone1"
CkRest_AddQueryParam $rest "$filter" "_parentcustomerid_value eq b0a19cdd-88df-e311-b8e5-6c3be5a8b200"

CkRest_AddHeader $rest "OData-MaxVersion" "4.0"
CkRest_AddHeader $rest "Accept" "application/json"
CkRest_AddHeader $rest "OData-Version" "4.0"
CkRest_AddHeader $rest "Authorization" "Bearer DYNAMICS_CRM_ACCESS_TOKEN"

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/api/data/v9.0/contacts" $sbResponseBody]
if {[expr $success != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_ResponseStatusCode $rest]
if {[expr $respStatusCode >= 400]} then {
    puts "Response Status Code = $respStatusCode"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jsonResponse [new_CkJsonObject]

CkJsonObject_LoadSb $jsonResponse $sbResponseBody

set odataContext [CkJsonObject_stringOf $jsonResponse "\"@odata.context\""]
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "value"]
while {[expr $i < $count_i]} {
    CkJsonObject_put_I $jsonResponse $i
    set odataEtag [CkJsonObject_stringOf $jsonResponse "value[i].\"@odata.etag\""]
    set fullname [CkJsonObject_stringOf $jsonResponse "value[i].fullname"]
    set emailaddress1 [CkJsonObject_stringOf $jsonResponse "value[i].emailaddress1"]
    set telephone1 [CkJsonObject_stringOf $jsonResponse "value[i].telephone1"]
    set contactid [CkJsonObject_stringOf $jsonResponse "value[i].contactid"]
    set i [expr $i + 1]
}

delete_CkRest $rest
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse

Sample JSON Response Body

{
  "@odata.context": "https://mydomain.api.crm.dynamics.com/api/data/v9.0/$metadata#contacts(fullname,emailaddress1,telephone1)",
  "value": [
    {
      "@odata.etag": "W/\"1162014\"",
      "fullname": "Cat Francis",
      "emailaddress1": "Cat@cohowinery.com",
      "telephone1": "123-879-9879",
      "contactid": "51a0e5b9-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1162210\"",
      "fullname": "Tomasz Bochenek",
      "emailaddress1": "tom@cohowinery.com",
      "telephone1": "456-698-4581",
      "contactid": "1fa1e5b9-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1162593\"",
      "fullname": "Kari Furse",
      "emailaddress1": "kari@cohowinery.com",
      "telephone1": "178-854-4576",
      "contactid": "9ba2e5b9-88df-e311-b8e5-6c3be5a8b200"
    },
    {
      "@odata.etag": "W/\"1162714\"",
      "fullname": "Wilson Pais",
      "emailaddress1": "wilson@cohowinery.com",
      "telephone1": "456-698-4582",
      "contactid": "6fa5e5b9-88df-e311-b8e5-6c3be5a8b200"
    }
  ]
}