Page Comparison

...
Excerpt
This method returns information related with contact information. Multiple contact information can be returned by each call
Resource URL

Parameters

Name
Type
Description
token
String
The token retrieved from the login method
id_number
(semi-optional)
String
The ID number of the contact information
passport_number
(semi-optional)
String
The passport number of the contact information
social_security_number
(semi-optional)
String
The social security number of the contact information
vat_registration_number
(semi-optional)
String
The registration number of the contact information
email_address
(semi-optional)
String
The email address of the contact information
Tip
Available from CRM.COM R13.0.0
phone_number
(semi-optional)
String
The phone number of the contact information
Tip
Available from CRM.COM R12.7.0
owned_by_group
(semi-optional)
Organisational Group Identifier
The identifier of the organisational group related with the accounts that will be returned as results. The allowed contact information identifier fields are the following:
Include Page
	V4:group_identifier
	V4:group_identifier
Tip
Available from CRM.COM R14.15.0
number_of_results
(optional)
Number
The number of results that can be retrieved through each call
Tip
Available from CRM.COM R13.0.0
offset
(optional)
Number
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip
Available from CRM.COM R13.0.0
fields_set
(optional)
List of Strings, comma separated
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions

It is mandatory to specify one of the semi-optional parameters. Multiple semi-optional parameters can be specified in each call
...
Expand
title	Example 1
HTTP Method: GET
Request:
Response:
Code Block
language	javascript
theme	Confluence	language	javascript
linenumbers	true
    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "udf_string_10": "userfield10",
               "organizational_unit": 0,
               "udf_float_1": 10,
               "udf_string_11": "userfield11",
               "udf_float_2": 12,
               "udf_string_12": "userfield12",
               "udf_float_3": 13,
               "udf_string_13": "userfield13",
               "udf_float_4": 14,
               "udf_string_14": "userfield14",
               "udf_float_5": 5,
               "udf_string_15": "userfield15",
               "udf_string_1": "userfield1",
               "name": "Maria Ioannou",
               "udf_string_16": "userfield16",
               "udf_float_6": 2,
               "udf_string_2": "userfield2",
               "udf_float_7": 1,
               "udf_string_3": "userfield3",
               "privacy_level":
               {
                   "number": null,
                   "hierarchy_level": 3,
                   "name": "Moderate",
                   "id": "9450216690684C416363B57DAD4596C3"
               },
               "company_name": null,
               "udf_float_8": 7,
               "udf_string_4": "userfield4",
               "udf_string_5": "userfield5",
               "udf_string_6": "userfield6",
               "udf_string_7": "userfield7",
               "udf_string_8": "userfield8",
               "udf_string_9": "userfield9",
               "last_name": "Ioannou",
               "id": "0514658236551391DE14490617FA49CA",
               "relation_set":
               [
               ],
               "log_information":
               {
                   "updated_date": "2014-10-24T09:17:07",
                   "created_by_unit":
                   {
                       "community_name": "Main Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2013-10-11T17:30:16",
                   "updated_by_unit":
                   {
                       "community_name": "Main Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "updated_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   }
               },
               "life_cycle_state": "FINANCIAL",
               "first_name": "Maria",
               "type": "PERSON",
               "addresses_set":
               [
                   {
                       "care_of": "MML",
                       "street_number": "12",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "ilia papakiriakou",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "1212",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 9,
                       "udf_string_3": null,
                       "area": "Makedonitisa",
                       "udf_string_4": null,
                       "district": "Nicosia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Inactive",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "CYPRUS",
                           "id": "181"
                       },
                       "id": "2E7D50026366AF98CD006C5883E825DA",
                       "postal_code": "pc0001",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "1323",
                       "apartment_number": "91",
                       "town_city": "Lefkosia",
                       "type": "Home",
                       "municipality": "Nicosia"
                   },
                   {
                       "care_of": "MML",
                       "street_number": "23",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "Egnatias 102",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "986548",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 2,
                       "udf_string_3": null,
                       "area": "Centre",
                       "udf_string_4": null,
                       "district": "Makedonia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "GREECE",
                           "id": "209"
                       },
                       "id": "5FDA3D490F36322B44AB621BDE288ECC",
                       "postal_code": "7061",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "986548-1",
                       "apartment_number": "203",
                       "town_city": "Thessaloniki",
                       "type": "Home",
                       "municipality": "voria ellada"
                   },
                   {
                       "care_of": "MML",
                       "street_number": "12",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "Olimpiados",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "986547",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 12,
                       "udf_string_3": null,
                       "area": "kamara",
                       "udf_string_4": null,
                       "district": "makedonia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "GREECE",
                           "id": "209"
                       },
                       "id": "D6B0827D10A0043ADE7198F0EC6D2D11",
                       "postal_code": "7060",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "986547-1",
                       "apartment_number": "4",
                       "town_city": "thessaloniki",
                       "type": "Business",
                       "municipality": "voria ellada"
                   }
               ],
               "title": "Miss",
               "company_profile":
               {
                   "tax_reference_number": null,
                   "annual_turnover": null,
                   "number_of_employees": null,
                   "profile_year": null,
                   "established_date": null,
                   "industry_sector":
                   {
                       "name": "EDUCATION",
                       "id": "AF6E0855324153EAB8B582A277147BCE",
                       "alternative_code": "1"
                   },
                   "registered_in_country": null,
                   "vat_registration_number": null,
                   "industry":
                   {
                       "name": "Interior Design",
                       "id": "06B638258885DA26FA2BD40D9128D04E",
                       "code": "INTDS"
                   },
                   "vat_registration_date": null,
                   "vat_registered_by": null,
                   "registration_number": null
               },
               "udf_date_1": "2014-05-05T15:49:59",
               "phones_set":
               [
                   {
                       "notes": "Honduras",
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "number": "988321236448",
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "country":
                       {
                           "name": "HONDURAS",
                           "id": "225"
                       },
                       "full_number": "504988321236448",
                       "type": "Landline",
                       "id": "F8E6B7A8135CA81CCEC810643E137CF6",
                       "area_code": "504"
                   }
               ],
               "udf_date_2": "2014-05-05T14:49:59",
               "udf_date_3": "2014-05-05T16:49:59",
               "udf_date_4": "2014-05-05T17:49:59",
               "udf_date_5": "2014-05-05T18:49:59",
               "udf_date_6": "2014-05-05T01:49:59",
               "demographics":
               {
                   "gender": "FEMALE",
                   "passport_issued_by_country":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "passport_number": "15420910",
                   "social_security_number": "15420920",
                   "country_of_residence":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "industry_sector":
                   {
                       "name": "EDUCATION",
                       "id": "AF6E0855324153EAB8B582A277147BCE",
                       "alternative_code": "1"
                   },
                   "date_of_birth":
                   {
                       "month": 5,
                       "day": 1,
                       "year": 1928
                   },
                   "name_day":
                   {
                       "month": 1,
                       "day": 7
                   },
                   "id_number": "154209",
                   "id_issued_by_country":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "industry":
                   {
                       "name": "Interior Design",
                       "id": "06B638258885DA26FA2BD40D9128D04E",
                       "code": "INTDS"
                   }
               },
               "udf_date_7": "2014-05-05T19:49:59",
               "udf_date_8": "2014-05-05T20:49:59",
               "owned_by_group":
               {
                   "community_name": "Main Community",
                   "name": "Nicosia Office",
                   "id": "68D54DA033606669621E3D2E4B355DA0",
                   "description": null,
                   "alternative_code": "NO"
               },
               "middle_name": "A.",
               "emails_set":
               [
                   {
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "type": "Business",
                       "id": "FAD6C644E1AE8216B05A56BAFE40CEFF",
                       "email": "mariaioannou@crm.com"
                   },
                   {
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "type": "Personal",
                       "id": "77BC050D87E7FCA0D2EED9A5B9C4DCCB",
                       "email": "mariaioannou@personalcrm.com"
                   }
               ],
               "category":
               {
                   "name": "Clients",
                   "id": "BF9E138C477E2450F2DB2C40CB5DF7FB",
                   "code": "CLS"
               }
           },
           {
               "udf_string_10": "userfield10",
               "organizational_unit": 0,
               "udf_float_1": 10,
               "udf_string_11": "userfield11",
               "udf_float_2": 12,
               "udf_string_12": "userfield12",
               "udf_float_3": 13,
               "udf_string_13": "userfield13",
               "udf_float_4": 14,
               "udf_string_14": "userfield14",
               "udf_float_5": 5,
               "udf_string_15": "userfield15",
               "udf_string_1": "userfield1",
               "name": "Marios Christodoulou",
               "udf_string_16": "userfield16",
               "udf_float_6": 2,
               "udf_string_2": "userfield2",
               "udf_float_7": 1,
               "udf_string_3": "userfield3",
               "privacy_level":
               {
                   "number": null,
                   "hierarchy_level": 1,
                   "name": "3",
                   "id": "0BA1A4672D1A071351BB1297A99F2915"
               },
               "company_name": null,
               "udf_float_8": 7,
               "udf_string_4": "userfield4",
               "udf_string_5": "userfield5",
               "udf_string_6": "userfield6",
               "udf_string_7": "userfield7",
               "udf_string_8": "userfield8",
               "udf_string_9": "userfield9",
               "last_name": "Christodoulou",
               "id": "4F9B9A0E0CCB894101AE977EDCFC7E18",
               "relation_set":
               [
               ],
               "log_information":
               {
                   "updated_date": "2014-10-24T13:25:21",
                   "created_by_unit":
                   {
                       "community_name": "Main Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-10-24T11:11:14",
                   "updated_by_unit":
                   {
                       "community_name": "Main Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "updated_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   }
               },
               "life_cycle_state": "MARKETING",
               "first_name": "Marios",
               "type": "PERSON",
               "addresses_set":
               [
                   {
                       "care_of": "MML",
                       "street_number": "23",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "Egnatias 102",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "986548",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 2,
                       "udf_string_3": null,
                       "area": "Centre",
                       "udf_string_4": null,
                       "district": "Makedonia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "UNITED KINGDOM",
                           "id": "126"
                       },
                       "id": "6CC99F6B9D87A44332E8A1789E2C2AC2",
                       "postal_code": "7061",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "986548-1",
                       "apartment_number": "203",
                       "town_city": "Thessaloniki",
                       "type": "Business",
                       "municipality": "voria ellada"
                   },
                   {
                       "care_of": "MML",
                       "street_number": "23",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "Egnatias 102",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "986548",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 2,
                       "udf_string_3": null,
                       "area": "Centre",
                       "udf_string_4": null,
                       "district": "Makedonia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "UNITED KINGDOM",
                           "id": "126"
                       },
                       "id": "3BC7A36F14234E81CD97BDF466F38FCE",
                       "postal_code": "7061",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "986548-1",
                       "apartment_number": "203",
                       "town_city": "Thessaloniki",
                       "type": "Home",
                       "municipality": "voria ellada"
                   }
               ],
               "title": "Sir",
               "company_profile":
               {
                   "tax_reference_number": null,
                   "annual_turnover": null,
                   "number_of_employees": null,
                   "profile_year": null,
                   "established_date": null,
                   "industry_sector": null,
                   "registered_in_country": null,
                   "vat_registration_number": null,
                   "industry":
                   {
                       "name": "Interior Design",
                       "id": "06B638258885DA26FA2BD40D9128D04E",
                       "code": "INTDS"
                   },
                   "vat_registration_date": null,
                   "vat_registered_by": null,
                   "registration_number": null
               },
               "udf_date_1": "2014-05-05T15:49:59",
               "phones_set":
               [
                   {
                       "notes": "Honduras",
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "number": "988321236448",
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "country":
                       {
                           "name": "UNITED KINGDOM",
                           "id": "126"
                       },
                       "full_number": "44988321236448",
                       "type": "Landline",
                       "id": "DBE65816407D8DF60C0E62BF87F07617",
                       "area_code": "44"
                   }
               ],
               "udf_date_2": "2014-05-05T14:49:59",
               "udf_date_3": "2014-05-05T16:49:59",
               "udf_date_4": "2014-05-05T17:49:59",
               "udf_date_5": "2014-05-05T18:49:59",
               "udf_date_6": "2014-05-05T01:49:59",
               "demographics":
               {
                   "gender": "MALE",
                   "passport_issued_by_country":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "passport_number": "15420910",
                   "social_security_number": "15420920",
                   "country_of_residence":
                   {
                       "name": "UNITED KINGDOM",
                       "id": "126"
                   },
                   "industry_sector": null,
                   "date_of_birth":
                   {
                       "month": 5,
                       "day": 1,
                       "year": 1928
                   },
                   "name_day":
                   {
                       "month": 1,
                       "day": 7
                   },
                   "id_number": "154209",
                   "id_issued_by_country":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "industry":
                   {
                       "name": "Interior Design",
                       "id": "06B638258885DA26FA2BD40D9128D04E",
                       "code": "INTDS"
                   }
               },
               "udf_date_7": "2014-05-05T19:49:59",
               "udf_date_8": "2014-05-05T20:49:59",
               "owned_by_group":
               {
                   "community_name": "Main Community",
                   "name": "Main Group",
                   "id": "84F33366CB592BAAE7E2044D93611C6A",
                   "description": "Main Group",
                   "alternative_code": "das"
               },
               "middle_name": "A.",
               "emails_set":
               [
                   {
                       "udf_float_1": 12,
                       "udf_float_2": 13,
                       "udf_date_1": "2014-09-12T09:44:20",
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": "udf_string1",
                       "udf_string_2": "udf_string2",
                       "udf_string_3": "udf_string3",
                       "udf_string_4": "udf_string4",
                       "udf_string_5": "udf_string5",
                       "udf_string_6": "udf_string6",
                       "udf_string_7": "udf_string7",
                       "state": "Active",
                       "udf_string_8": "udf_string8",
                       "type": "Personal",
                       "id": "B4211DE145CD3AA03AAB93C61C9070AA",
                       "email": "mariaioannou@personalcrm.com"
                   },
                   {
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "type": "Business",
                       "id": "42FB2FDF0CE0C2A9EC1CD173FCAEFB89",
                       "email": "mariaioannou@crm.com"
                   }
               ],
               "category":
               {
                   "name": "Clients",
                   "id": "BF9E138C477E2450F2DB2C40CB5DF7FB",
                   "code": "CLS"
               }
           }
       ]
    }
...
Versions Compared

Old Version 5

New Version 6

Key

Resource URL

Parameters

Restrictions
