Skip to content

Retrieve a contact

This method hands out a user's contact address by ID.

GET /offer/v1.0/user/{username}/contact/{id or ext-externalId}

Supported media types:
XML
JSON

Request

Path Parameters

id / externalId cannot be used at the same time.

PARAMETER DESCRIPTION
Username the username which the user uses for logging in to www.immobilienscout24
me "me" can be used instead of the username, when the user is logged in by 3-legged OAuth
id the unique Scout object id, which is generated with POST REALESTATE, automatically
externalId the contact id of the rest api client. It must be unique for a user and must contain the prefix "ext-"

Example:

GET https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/999999/contact/58850320

hands out the contact address with the scout contact id=58850320.

OR

GET https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username}/contact/ext-a001

hands out the contact address with the external contact id=a001

Response

XML:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
<?xml version="1.0" encoding="UTF-8"?>
<common:realtorContactDetails xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
xmlns:ns3="http://rest.immobilienscout24.de/schema/customer/1.0"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns5="http://rest.immobilienscout24.de/schema/user/1.0" id="57433642">
    <email>max.mustermann@immobilienscout24.de</email>
    <salutation>MALE</salutation>
    <firstname>Max</firstname>
    <lastname>Mustermann</lastname>
    <faxNumberCountryCode>+49</faxNumberCountryCode>
    <faxNumberAreaCode>30</faxNumberAreaCode>
    <faxNumberSubscriber>243010001</faxNumberSubscriber>
    <phoneNumberCountryCode>+49</phoneNumberCountryCode>
    <phoneNumberAreaCode>30</phoneNumberAreaCode>
    <phoneNumberSubscriber>243010001</phoneNumberSubscriber>
    <cellPhoneNumberCountryCode>+49</cellPhoneNumberCountryCode>
    <cellPhoneNumberAreaCode>179</cellPhoneNumberAreaCode>
    <cellPhoneNumberSubscriber>24301000 1</cellPhoneNumberSubscriber>
    <address>
        <street>Andreasstr.</street>
        <houseNumber>10</houseNumber>
        <postcode>10243</postcode>
        <city>Berlin</city>
    </address>
    <countryCode>DEU</countryCode>
    <title>Master</title>
    <additionName>HuiBuh</additionName>
    <homepageUrl>http://www.immobilienscout24.de</homepageUrl>    
    <position>position oder taetigkeit im unternehmen</position>
    <secondaryEmail>secondary-email@example.com</secondaryEmail>
    <officeHours>Von 11:30 bis 12:00, dabei eine halbe Stunde Pause, field is no longer used or visible in the is24 website</officeHours>   
    <defaultContact>false</defaultContact>
    <localPartnerContact>false</localPartnerContact>
    <businessCardContact>false</businessCardContact>
    <realEstateReferenceCount>2</realEstateReferenceCount>
    <externalId>a-001</externalId>
    <showOnProfilePage>true</showOnProfilePage>      
</common:realtorContactDetail>

JSON:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  "common.realtorContactDetail" : {
    "@id" : "57573183",
    "salutation" : "MALE",
    "firstname" : "Max",
    "lastname" : "Mustermann",
    "phoneNumberCountryCode" : "+49",
    "phoneNumberAreaCode" : "30",
    "phoneNumberSubscriber" : "243010000",
    "cellPhoneNumberCountryCode" : "+49" ,
    "cellPhoneNumberAreaCode" : "1520",
    "cellPhoneNumberSubscriber": "1111111" ,
    "address" : {
      "street" : "Andreasstr.",
      "houseNumber" : "10",
      "postcode" : "10243",
      "city" : "Berlin"
    },
    "countryCode" : "DEU",
    "title" : "Master",
    "additionName" : "HuiBuh" ,
    "homepageUrl" : "http://www.immobilienscout24.de" ,
    "position":"position oder taetigkeit im unternehmen",
    "secondaryEmail" : "secondary-email@example.com",
    "officeHours" : "Von  11:30 bis 12:00, dabei eine halbe Stunde Pause, field is no longer used or visible in the is24 website" ,
    "defaultContact" : false,
    "localPartnerContact" : false,
    "businessCardContact" : false,
    "realEstateReferenceCount" : 1,
    "externalId" : "a-001",
    "showOnProfilePage":"true"   
 }
}