Excel Dynamics CRM: Retrieve a Single Contact

Back to Index

Returns the full contact record for a given contactid.

Documentation: https://msdn.microsoft.com/en-us/library/gg334767.aspx#Basic query example

CURL Command

curl -X GET https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/contacts(1fa1e5b9-88df-e311-b8e5-6c3be5a8b200) \
  -H "Accept: application/json" \
  -H "OData-MaxVersion: 4.0"  \
  -H "OData-Version: 4.0" \
  -H "Authorization: Bearer DYNAMICS_CRM_ACCESS_TOKEN"

Excel Example

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

'  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/contacts(1fa1e5b9-88df-e311-b8e5-6c3be5a8b200)

bTls = True

port = 443

bAutoReconnect = True
success = rest.Connect("my-dynamics-domain.api.crm.dynamics.com",port,bTls,bAutoReconnect)
If (success <> True) Then
    Debug.Print "ConnectFailReason: "; rest.ConnectFailReason
    Debug.Print rest.LastErrorText
    Exit Sub
End If

success = rest.AddHeader("OData-MaxVersion","4.0")
success = rest.AddHeader("Accept","application/json")
success = rest.AddHeader("OData-Version","4.0")
success = rest.AddHeader("Authorization","Bearer DYNAMICS_CRM_ACCESS_TOKEN")

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = rest.FullRequestNoBodySb("GET","/api/data/v9.0/contacts(1fa1e5b9-88df-e311-b8e5-6c3be5a8b200)",sbResponseBody)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If


respStatusCode = rest.ResponseStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Status Code = "; respStatusCode
    Debug.Print "Response Header:"
    Debug.Print rest.ResponseHeader
    Debug.Print "Response Body:"
    Debug.Print sbResponseBody.GetAsString()
    Exit Sub
End If

Dim jsonResponse As Chilkat.JsonObject
Set jsonResponse = Chilkat.NewJsonObject
success = jsonResponse.LoadSb(sbResponseBody)


odataContext = jsonResponse.StringOf("""@odata.context""")

odataEtag = jsonResponse.StringOf("""@odata.etag""")

customertypecode = jsonResponse.IntOf("customertypecode")

address1_latitude = jsonResponse.IntOf("address1_latitude")

birthdate = jsonResponse.StringOf("birthdate")

merged = jsonResponse.BoolOf("merged")

gendercode = jsonResponse.IntOf("gendercode")

territorycode = jsonResponse.IntOf("territorycode")

emailaddress1 = jsonResponse.StringOf("emailaddress1")

haschildrencode = jsonResponse.IntOf("haschildrencode")

preferredappointmenttimecode = jsonResponse.IntOf("preferredappointmenttimecode")

isbackofficecustomer = jsonResponse.BoolOf("isbackofficecustomer")

modifiedon = jsonResponse.StringOf("modifiedon")

v_owninguser_value = jsonResponse.StringOf("_owninguser_value")

importsequencenumber = jsonResponse.IntOf("importsequencenumber")

address1_composite = jsonResponse.StringOf("address1_composite")

address1_longitude = jsonResponse.IntOf("address1_longitude")

marketingonly = jsonResponse.BoolOf("marketingonly")

donotphone = jsonResponse.BoolOf("donotphone")

preferredcontactmethodcode = jsonResponse.IntOf("preferredcontactmethodcode")

educationcode = jsonResponse.IntOf("educationcode")

v_ownerid_value = jsonResponse.StringOf("_ownerid_value")

customersizecode = jsonResponse.IntOf("customersizecode")

firstname = jsonResponse.StringOf("firstname")

donotpostalmail = jsonResponse.BoolOf("donotpostalmail")

yomifullname = jsonResponse.StringOf("yomifullname")

address2_addresstypecode = jsonResponse.IntOf("address2_addresstypecode")

donotemail = jsonResponse.BoolOf("donotemail")

address2_shippingmethodcode = jsonResponse.IntOf("address2_shippingmethodcode")

fullname = jsonResponse.StringOf("fullname")

timezoneruleversionnumber = jsonResponse.IntOf("timezoneruleversionnumber")

address1_addressid = jsonResponse.StringOf("address1_addressid")

address2_freighttermscode = jsonResponse.IntOf("address2_freighttermscode")

statuscode = jsonResponse.IntOf("statuscode")

createdon = jsonResponse.StringOf("createdon")

address1_stateorprovince = jsonResponse.StringOf("address1_stateorprovince")

lastname = jsonResponse.StringOf("lastname")

donotsendmm = jsonResponse.BoolOf("donotsendmm")

donotfax = jsonResponse.BoolOf("donotfax")

leadsourcecode = jsonResponse.IntOf("leadsourcecode")

address1_country = jsonResponse.StringOf("address1_country")

versionnumber = jsonResponse.IntOf("versionnumber")

address1_line1 = jsonResponse.StringOf("address1_line1")

creditonhold = jsonResponse.BoolOf("creditonhold")

telephone1 = jsonResponse.StringOf("telephone1")

v_owningbusinessunit_value = jsonResponse.StringOf("_owningbusinessunit_value")

address3_addressid = jsonResponse.StringOf("address3_addressid")

donotbulkemail = jsonResponse.BoolOf("donotbulkemail")

v_modifiedby_value = jsonResponse.StringOf("_modifiedby_value")

followemail = jsonResponse.BoolOf("followemail")

shippingmethodcode = jsonResponse.IntOf("shippingmethodcode")

v_createdby_value = jsonResponse.StringOf("_createdby_value")

address1_city = jsonResponse.StringOf("address1_city")

donotbulkpostalmail = jsonResponse.BoolOf("donotbulkpostalmail")

v_parentcustomerid_value = jsonResponse.StringOf("_parentcustomerid_value")

contactid = jsonResponse.StringOf("contactid")

participatesinworkflow = jsonResponse.BoolOf("participatesinworkflow")

statecode = jsonResponse.IntOf("statecode")

overriddencreatedon = jsonResponse.StringOf("overriddencreatedon")

address2_addressid = jsonResponse.StringOf("address2_addressid")

address1_postalcode = jsonResponse.StringOf("address1_postalcode")

int_kloutscore = jsonResponse.IntOf("int_kloutscore")

spousesname = jsonResponse.StringOf("spousesname")

emailaddress3 = jsonResponse.StringOf("emailaddress3")

address3_telephone3 = jsonResponse.StringOf("address3_telephone3")

mobilephone = jsonResponse.StringOf("mobilephone")

utcconversiontimezonecode = jsonResponse.StringOf("utcconversiontimezonecode")

v_preferredserviceid_value = jsonResponse.StringOf("_preferredserviceid_value")

address3_shippingmethodcode = jsonResponse.StringOf("address3_shippingmethodcode")

int_twitterservice = jsonResponse.StringOf("int_twitterservice")

annualincome = jsonResponse.StringOf("annualincome")

fax = jsonResponse.StringOf("fax")

telephone3 = jsonResponse.StringOf("telephone3")

address1_primarycontactname = jsonResponse.StringOf("address1_primarycontactname")

address3_city = jsonResponse.StringOf("address3_city")

lastonholdtime = jsonResponse.StringOf("lastonholdtime")

address2_stateorprovince = jsonResponse.StringOf("address2_stateorprovince")

address2_line1 = jsonResponse.StringOf("address2_line1")

assistantphone = jsonResponse.StringOf("assistantphone")

lastusedincampaign = jsonResponse.StringOf("lastusedincampaign")

address3_freighttermscode = jsonResponse.StringOf("address3_freighttermscode")

pager = jsonResponse.StringOf("pager")

employeeid = jsonResponse.StringOf("employeeid")

managername = jsonResponse.StringOf("managername")

address1_name = jsonResponse.StringOf("address1_name")

department = jsonResponse.StringOf("department")

address3_country = jsonResponse.StringOf("address3_country")

address2_telephone1 = jsonResponse.StringOf("address2_telephone1")

address2_primarycontactname = jsonResponse.StringOf("address2_primarycontactname")

address2_latitude = jsonResponse.StringOf("address2_latitude")

address3_latitude = jsonResponse.StringOf("address3_latitude")

address2_postalcode = jsonResponse.StringOf("address2_postalcode")

entityimage_timestamp = jsonResponse.StringOf("entityimage_timestamp")

v_originatingleadid_value = jsonResponse.StringOf("_originatingleadid_value")

v_masterid_value = jsonResponse.StringOf("_masterid_value")

v_createdonbehalfby_value = jsonResponse.StringOf("_createdonbehalfby_value")

address3_postofficebox = jsonResponse.StringOf("address3_postofficebox")

subscriptionid = jsonResponse.StringOf("subscriptionid")

business2 = jsonResponse.StringOf("business2")

address3_county = jsonResponse.StringOf("address3_county")

address1_telephone2 = jsonResponse.StringOf("address1_telephone2")

address1_freighttermscode = jsonResponse.StringOf("address1_freighttermscode")

address3_addresstypecode = jsonResponse.StringOf("address3_addresstypecode")

address1_addresstypecode = jsonResponse.StringOf("address1_addresstypecode")

aging90_base = jsonResponse.StringOf("aging90_base")

address3_primarycontactname = jsonResponse.StringOf("address3_primarycontactname")

familystatuscode = jsonResponse.StringOf("familystatuscode")

home2 = jsonResponse.StringOf("home2")

int_kloutscoreservice = jsonResponse.StringOf("int_kloutscoreservice")

address2_utcoffset = jsonResponse.StringOf("address2_utcoffset")

aging60 = jsonResponse.StringOf("aging60")

telephone2 = jsonResponse.StringOf("telephone2")

yomimiddlename = jsonResponse.StringOf("yomimiddlename")

v_modifiedonbehalfby_value = jsonResponse.StringOf("_modifiedonbehalfby_value")

jobtitle = jsonResponse.StringOf("jobtitle")

address3_utcoffset = jsonResponse.StringOf("address3_utcoffset")

address1_telephone3 = jsonResponse.StringOf("address1_telephone3")

address2_line2 = jsonResponse.StringOf("address2_line2")

creditlimit_base = jsonResponse.StringOf("creditlimit_base")

address3_line1 = jsonResponse.StringOf("address3_line1")

address1_county = jsonResponse.StringOf("address1_county")

v_createdbyexternalparty_value = jsonResponse.StringOf("_createdbyexternalparty_value")

entityimageid = jsonResponse.StringOf("entityimageid")

processid = jsonResponse.StringOf("processid")

int_facebook = jsonResponse.StringOf("int_facebook")

description = jsonResponse.StringOf("description")

address1_fax = jsonResponse.StringOf("address1_fax")

address3_line2 = jsonResponse.StringOf("address3_line2")

externaluseridentifier = jsonResponse.StringOf("externaluseridentifier")

int_facebookservice = jsonResponse.StringOf("int_facebookservice")

aging30_base = jsonResponse.StringOf("aging30_base")

v_callback = jsonResponse.StringOf("callback")

emailaddress2 = jsonResponse.StringOf("emailaddress2")

address2_line3 = jsonResponse.StringOf("address2_line3")

managerphone = jsonResponse.StringOf("managerphone")

websiteurl = jsonResponse.StringOf("websiteurl")

exchangerate = jsonResponse.StringOf("exchangerate")

address1_telephone1 = jsonResponse.StringOf("address1_telephone1")

address3_composite = jsonResponse.StringOf("address3_composite")

address3_fax = jsonResponse.StringOf("address3_fax")

childrensnames = jsonResponse.StringOf("childrensnames")

v_owningteam_value = jsonResponse.StringOf("_owningteam_value")

numberofchildren = jsonResponse.StringOf("numberofchildren")

address2_postofficebox = jsonResponse.StringOf("address2_postofficebox")

aging90 = jsonResponse.StringOf("aging90")

aging60_base = jsonResponse.StringOf("aging60_base")

v_transactioncurrencyid_value = jsonResponse.StringOf("_transactioncurrencyid_value")

entityimage = jsonResponse.StringOf("entityimage")

v_modifiedbyexternalparty_value = jsonResponse.StringOf("_modifiedbyexternalparty_value")

paymenttermscode = jsonResponse.StringOf("paymenttermscode")

address3_name = jsonResponse.StringOf("address3_name")

ftpsiteurl = jsonResponse.StringOf("ftpsiteurl")

address1_shippingmethodcode = jsonResponse.StringOf("address1_shippingmethodcode")

v_preferredsystemuserid_value = jsonResponse.StringOf("_preferredsystemuserid_value")

address2_telephone2 = jsonResponse.StringOf("address2_telephone2")

v_slainvokedid_value = jsonResponse.StringOf("_slainvokedid_value")

address3_telephone1 = jsonResponse.StringOf("address3_telephone1")

nickname = jsonResponse.StringOf("nickname")

address1_postofficebox = jsonResponse.StringOf("address1_postofficebox")

v_preferredequipmentid_value = jsonResponse.StringOf("_preferredequipmentid_value")

assistantname = jsonResponse.StringOf("assistantname")

address2_country = jsonResponse.StringOf("address2_country")

v_accountid_value = jsonResponse.StringOf("_accountid_value")

address2_name = jsonResponse.StringOf("address2_name")

stageid = jsonResponse.StringOf("stageid")

address3_longitude = jsonResponse.StringOf("address3_longitude")

onholdtime = jsonResponse.StringOf("onholdtime")

address2_telephone3 = jsonResponse.StringOf("address2_telephone3")

address3_upszone = jsonResponse.StringOf("address3_upszone")

aging30 = jsonResponse.StringOf("aging30")

address2_upszone = jsonResponse.StringOf("address2_upszone")

address1_upszone = jsonResponse.StringOf("address1_upszone")

creditlimit = jsonResponse.StringOf("creditlimit")

salutation = jsonResponse.StringOf("salutation")

traversedpath = jsonResponse.StringOf("traversedpath")

accountrolecode = jsonResponse.StringOf("accountrolecode")

address1_utcoffset = jsonResponse.StringOf("address1_utcoffset")

governmentid = jsonResponse.StringOf("governmentid")

annualincome_base = jsonResponse.StringOf("annualincome_base")

address3_stateorprovince = jsonResponse.StringOf("address3_stateorprovince")

address3_postalcode = jsonResponse.StringOf("address3_postalcode")

address2_city = jsonResponse.StringOf("address2_city")

msdyn_gdproptout = jsonResponse.StringOf("msdyn_gdproptout")

company = jsonResponse.StringOf("company")

address1_line2 = jsonResponse.StringOf("address1_line2")

address2_longitude = jsonResponse.StringOf("address2_longitude")

int_twitter = jsonResponse.StringOf("int_twitter")

address3_telephone2 = jsonResponse.StringOf("address3_telephone2")

yomifirstname = jsonResponse.StringOf("yomifirstname")

address2_composite = jsonResponse.StringOf("address2_composite")

address2_county = jsonResponse.StringOf("address2_county")

suffix = jsonResponse.StringOf("suffix")

anniversary = jsonResponse.StringOf("anniversary")

v_parentcontactid_value = jsonResponse.StringOf("_parentcontactid_value")

address2_fax = jsonResponse.StringOf("address2_fax")

yomilastname = jsonResponse.StringOf("yomilastname")

preferredappointmentdaycode = jsonResponse.StringOf("preferredappointmentdaycode")

entityimage_url = jsonResponse.StringOf("entityimage_url")

address1_line3 = jsonResponse.StringOf("address1_line3")

v_defaultpricelevelid_value = jsonResponse.StringOf("_defaultpricelevelid_value")

v_slaid_value = jsonResponse.StringOf("_slaid_value")

middlename = jsonResponse.StringOf("middlename")

address3_line3 = jsonResponse.StringOf("address3_line3")

timespentbymeonemailandmeetings = jsonResponse.StringOf("timespentbymeonemailandmeetings")

Sample JSON Response Body

{
  "@odata.context": "https://mydomain.api.crm.dynamics.com/api/data/v9.0/$metadata#contacts/$entity",
  "@odata.etag": "W/\"1162210\"",
  "customertypecode": 1,
  "address1_latitude": 35.82096,
  "birthdate": "1965-05-24",
  "merged": false,
  "gendercode": 1,
  "territorycode": 1,
  "emailaddress1": "tom@cohowinery.com",
  "haschildrencode": 1,
  "preferredappointmenttimecode": 1,
  "isbackofficecustomer": false,
  "modifiedon": "2018-03-12T16:09:53Z",
  "_owninguser_value": "55e68414-a277-42d6-ba36-d90484708a1d",
  "importsequencenumber": 104,
  "address1_composite": "4405 Balboa Court\r\nSanta Cruz, NM 72052\r\nUS",
  "address1_longitude": -106.21346,
  "marketingonly": false,
  "donotphone": false,
  "preferredcontactmethodcode": 1,
  "educationcode": 1,
  "_ownerid_value": "55e68414-a277-42d6-ba36-d90484708a1d",
  "customersizecode": 1,
  "firstname": "Tomasz",
  "donotpostalmail": false,
  "yomifullname": "Tomasz Bochenek",
  "address2_addresstypecode": 1,
  "donotemail": false,
  "address2_shippingmethodcode": 1,
  "fullname": "Tomasz Bochenek",
  "timezoneruleversionnumber": 0,
  "address1_addressid": "c3a917d8-1daa-463b-a4ac-f6d9878d7456",
  "address2_freighttermscode": 1,
  "statuscode": 1,
  "createdon": "2017-01-20T22:40:01Z",
  "address1_stateorprovince": "NM",
  "lastname": "Bochenek",
  "donotsendmm": false,
  "donotfax": false,
  "leadsourcecode": 1,
  "address1_country": "US",
  "versionnumber": 1162210,
  "address1_line1": "4405 Balboa Court",
  "creditonhold": false,
  "telephone1": "456-698-4581",
  "_owningbusinessunit_value": "c4106190-c81e-e811-a980-000d3a192e9a",
  "address3_addressid": "e3e5cc17-4990-4d08-8a4d-c16ca45217ab",
  "donotbulkemail": false,
  "_modifiedby_value": "e00ba668-e2de-47bc-8f92-ab9573f92ff4",
  "followemail": true,
  "shippingmethodcode": 1,
  "_createdby_value": "55e68414-a277-42d6-ba36-d90484708a1d",
  "address1_city": "Santa Cruz",
  "donotbulkpostalmail": false,
  "_parentcustomerid_value": "b0a19cdd-88df-e311-b8e5-6c3be5a8b200",
  "contactid": "1fa1e5b9-88df-e311-b8e5-6c3be5a8b200",
  "participatesinworkflow": false,
  "statecode": 0,
  "overriddencreatedon": "2018-03-03T12:22:25Z",
  "address2_addressid": "fee626cd-e834-4a68-a54e-b98c23847b2d",
  "address1_postalcode": "72052",
  "int_kloutscore": 90,
  "spousesname": null,
  "emailaddress3": null,
  "address3_telephone3": null,
  "mobilephone": null,
  "utcconversiontimezonecode": null,
  "_preferredserviceid_value": null,
  "address3_shippingmethodcode": null,
  "int_twitterservice": null,
  "annualincome": null,
  "fax": null,
  "telephone3": null,
  "address1_primarycontactname": null,
  "address3_city": null,
  "lastonholdtime": null,
  "address2_stateorprovince": null,
  "address2_line1": null,
  "assistantphone": null,
  "lastusedincampaign": null,
  "address3_freighttermscode": null,
  "pager": null,
  "employeeid": null,
  "managername": null,
  "address1_name": null,
  "department": null,
  "address3_country": null,
  "address2_telephone1": null,
  "address2_primarycontactname": null,
  "address2_latitude": null,
  "address3_latitude": null,
  "address2_postalcode": null,
  "entityimage_timestamp": null,
  "_originatingleadid_value": null,
  "_masterid_value": null,
  "_createdonbehalfby_value": null,
  "address3_postofficebox": null,
  "subscriptionid": null,
  "business2": null,
  "address3_county": null,
  "address1_telephone2": null,
  "address1_freighttermscode": null,
  "address3_addresstypecode": null,
  "address1_addresstypecode": null,
  "aging90_base": null,
  "address3_primarycontactname": null,
  "familystatuscode": null,
  "home2": null,
  "int_kloutscoreservice": null,
  "address2_utcoffset": null,
  "aging60": null,
  "telephone2": null,
  "yomimiddlename": null,
  "_modifiedonbehalfby_value": null,
  "jobtitle": null,
  "address3_utcoffset": null,
  "address1_telephone3": null,
  "address2_line2": null,
  "creditlimit_base": null,
  "address3_line1": null,
  "address1_county": null,
  "_createdbyexternalparty_value": null,
  "entityimageid": null,
  "processid": null,
  "int_facebook": null,
  "description": null,
  "address1_fax": null,
  "address3_line2": null,
  "externaluseridentifier": null,
  "int_facebookservice": null,
  "aging30_base": null,
  "callback": null,
  "emailaddress2": null,
  "address2_line3": null,
  "managerphone": null,
  "websiteurl": null,
  "exchangerate": null,
  "address1_telephone1": null,
  "address3_composite": null,
  "address3_fax": null,
  "childrensnames": null,
  "_owningteam_value": null,
  "numberofchildren": null,
  "address2_postofficebox": null,
  "aging90": null,
  "aging60_base": null,
  "_transactioncurrencyid_value": null,
  "entityimage": null,
  "_modifiedbyexternalparty_value": null,
  "paymenttermscode": null,
  "address3_name": null,
  "ftpsiteurl": null,
  "address1_shippingmethodcode": null,
  "_preferredsystemuserid_value": null,
  "address2_telephone2": null,
  "_slainvokedid_value": null,
  "address3_telephone1": null,
  "nickname": null,
  "address1_postofficebox": null,
  "_preferredequipmentid_value": null,
  "assistantname": null,
  "address2_country": null,
  "_accountid_value": null,
  "address2_name": null,
  "stageid": null,
  "address3_longitude": null,
  "onholdtime": null,
  "address2_telephone3": null,
  "address3_upszone": null,
  "aging30": null,
  "address2_upszone": null,
  "address1_upszone": null,
  "creditlimit": null,
  "salutation": null,
  "traversedpath": null,
  "accountrolecode": null,
  "address1_utcoffset": null,
  "governmentid": null,
  "annualincome_base": null,
  "address3_stateorprovince": null,
  "address3_postalcode": null,
  "address2_city": null,
  "msdyn_gdproptout": null,
  "company": null,
  "address1_line2": null,
  "address2_longitude": null,
  "int_twitter": null,
  "address3_telephone2": null,
  "yomifirstname": null,
  "address2_composite": null,
  "address2_county": null,
  "suffix": null,
  "anniversary": null,
  "_parentcontactid_value": null,
  "address2_fax": null,
  "yomilastname": null,
  "preferredappointmentdaycode": null,
  "entityimage_url": null,
  "address1_line3": null,
  "_defaultpricelevelid_value": null,
  "_slaid_value": null,
  "middlename": null,
  "address3_line3": null,
  "timespentbymeonemailandmeetings": null
}