- Created by Former user , last modified by p_demou (Deactivated) on Sept 24, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 7 Current »
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 Available from CRM.COM R13.0.0 | ||||||||||||
phone_number (semi-optional) | String | The phone number of the contact information Available from CRM.COM R12.7.0 | ||||||||||||
owned_by_group_identifier (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:
Available from CRM.COM R14.15.0 | ||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call 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 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
Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
title | String | The title of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
notes | String | Notes for the contact information |
organizational_unit | Integer | Indicates whether a contacts belongs to an organisational unit or not |
preferred_language | String | The Contact Information's preferred language. The available values are:
Available from CRM.COM R12.0.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_string_9 | String | User Defined Field of type String |
udf_string_10 | String | User Defined Field of type String |
udf_string_11 | String | User Defined Field of type String |
udf_string_12 | String | User Defined Field of type String |
udf_string_13 | String | User Defined Field of type String |
udf_string_14 | String | User Defined Field of type String |
udf_string_15 | String | User Defined Field of type String |
udf_string_16 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_float_5 | Float | User Defined Field of type Float |
udf_float_6 | Float | User Defined Field of type Float |
udf_float_7 | Float | User Defined Field of type Float |
udf_float_8 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
udf_date_5 | Date | User Defined Field of type Date |
udf_date_6 | Date | User Defined Field of type Date |
udf_date_7 | Date | User Defined Field of type Date |
udf_date_8 | Date | User Defined Field of type Date |
kyc_profile | KYC profile object | The KYC profile information of the retrieved contact information Available from CRM.COM R14.0.0 |
Demographics object | The demographics of the retrieved contact information | |
Company profile object | The company profile of the retrieved contact information | |
Category object | The category of the retrieved contact information | |
owned_by_group | Group object | The group that is owning the contact information Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
owned_by_business_unit | Business Unit Object | The business unit that is owning the contact information Available from CRM.COM R18.0.0 |
privacy_level | Privacy level object | The contact information's privacy level |
Log Information Object | The log information related with the retrieved accounts receivable | |
Set of Contact information address Object | The addresses of the retrieved contact information | |
Set of Contact information phone Object | The phones of the retrieved contact information | |
Set of Contact information email Object | The emails of the retrieved contact information | |
relation_set | Set of Contact Information business and personal relation Objects | The business and personal relations of the retrieved contact information |
authorization_settings | Contact Information Authorization settings object | The contact information's authorization settings information Available from CRM.COM R9.0.0 |
consent_information | Contact Consent Object | The contact information's consent information Available from CRM.COM R14.1.0 |
Referred Objects Response Data
Name | Type | Description |
kyc_profile_name | String | The KYC profile of the retrieved contact information |
kyc_profile_expiration_date | Date | The KYC profile's expiration date |
kyc_profile_state | String | The KYC profile's life cycle state. Available values are: PENDING_VERIFICATION, VERIFIED, REFUTE, EXPIRED |
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved category |
name | String | The name of the retrieved category |
code | String | The code of the retrieved category |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved group |
name | String | The name of the retrieved group |
community_name | String | The name of the community that the retrieved group belongs to |
alternative_code | String | The alternative code of the retrieved group |
unified_code | String | The unified code of the retrieved group Available from CRM.COM R16.2.2 |
description | String | The description of the retrieved group |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
code | String | The code of the retrieved business unit |
unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved privacy level |
number | String | The number of the retrieved privacy level |
name | String | The name of the retrieved privacy level |
hierarchy_level | String | The hierarchy level of the retrieved privacy level |
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
code | String | The code of the retrieved business unit |
unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
From R14.2.0, the following object is applicable for CRM.COM Address Format
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved address |
type | String | The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
postal_code | String | The postal code of the retrieved address |
street_name | String | The street name of the retrieved address |
street_number | String | The street number of the retrieved address |
floor | Integer | The floor of the retrieved address |
apartment_number | String | The apartment number of the retrieved address |
area | String | The area of the retrieved address |
town_city | String | The town / city of the retrieved address |
district | String | The district of the retrieved address |
municipality | String | The municipality of the retrieved address |
po_box | String | The PO box of the retrieved address |
po_box_postal_code | String | The PO box postal code of the retrieved address |
care_of | String | The care of person of the retrieved address |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_string_9 | String | User Defined Field of type String |
udf_string_10 | String | User Defined Field of type String |
udf_string_11 | String | User Defined Field of type String |
udf_string_12 | String | User Defined Field of type String |
udf_string_13 | String | User Defined Field of type String |
udf_string_14 | String | User Defined Field of type String |
udf_string_15 | String | User Defined Field of type String |
udf_string_16 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Country Object | The country of the retrieved address | |
is_primary | Boolean | Defines if the address is the contact's primary address or not. Available from CRM.COM R15 |
From R14.2.0, the following object is applicable for International Address Format
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved address |
type | String | The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
postal_code | String | The postal code of the retrieved address |
town_city | String | The town / city of the retrieved address |
address_line_1 | String | The address line 1 |
address_line_2 | String | The address line 2 |
state_province_county | String | The state or province or county of the address. |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_string_9 | String | User Defined Field of type String |
udf_string_10 | String | User Defined Field of type String |
udf_string_11 | String | User Defined Field of type String |
udf_string_12 | String | User Defined Field of type String |
udf_string_13 | String | User Defined Field of type String |
udf_string_14 | String | User Defined Field of type String |
udf_string_15 | String | User Defined Field of type String |
udf_string_16 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Country Object | The country of the retrieved address | |
is_primary | Boolean | Defines if the address is the contact's primary address or not. Available from CRM.COM R15 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved phone |
type | String | The type of the retrieved phone which can be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
number | String | The number of the retrieved phone |
area_code | String | The area code of the retrieved phone |
full_number | String | The full number of the retrieved phone |
notes | String | The notes of the retrieved phone |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Country Object | The country of the retrieved phone | |
is_primary | Boolean | Defines if the phone is the contact's primary phone or not. Available from CRM.COM R15 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved email |
type | String | The type of the retrieved email which can be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
email_address | String | The address of the retrieved email |
notes | String | The notes of the retrieved email |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
is_primary
| Boolean | Defines if the email is the contact's primary email or not. Available from CRM.COM R15 |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information business or personal relation |
type | String | The type of the retrieved contact information business or personal relation which can be FAMILY MEMBER, EXTENDED FAMILY, PARTNER, CLOSE FRIEND, FRIEND, WORK COLLEAGUE, PARTNER COMPANY, CLIENT, EMPLOYER, EMPLOYEE, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
relation_type | String | The relation type of the retrieved contact information The supported values are INWARD, OUTWARD Available from CRM.COM R14.2.0 Deprecated from CRM.COM R17 |
notes | String | The notes of the retrieved contact information business or personal relation |
contact_information | Contact Information Object | The related contact information |
Referred Response Objects Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
send_direct_ marketing_material | Boolean | Defines whether the contact wants to be contacted for Direct Marketing purposes |
direct_marketing_setting_updated_date | Date | The last date that the contact information's authorization setting for Direct Marketing was updated |
send_affiliate_ marketing_material | Boolean | Defines whether the contact wants to be contacted for Affiliate Marketing purposes |
affiliate_marketing_setting_updated_date | Date | The last date that the contact information's authorization setting for Affiliate Marketing was updated |
User Object | The name of the last user that updated the contact information's authorization setting for Affiliate Marketing | |
User Object | The name of the last user that updated the contact information's authorization setting for Affiliate Marketing |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Name | Type | Description |
id | String | The ID of the retrieved contact information |
contact_consent_state | String | The state of the Contact's Consent. Applicable values are:
|
contact_consent_updated_date | Date | The updated date of the Contact's Consent |
contact_consent_form | Attachments Object | The Contact's accepted Consent Form. Applicable only if Consent State is ACCEPTED |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved attachment |
entity | String | The name of the entity related with the attachment. The supported entities are the following:
From CRM.COM R12.2.0, ATTACHMENTSLIBRARY is available From CRM.COM R14.0.0, COMMUNICATIONTEMPLATES is available |
entity_id | String | The ID of the entity related with the attachment. |
url | String | The attached URL. This information is empty if the attachment is a file. |
notes | String | The comments related with the retrieved attachment |
classification | Attachments Classification Object | The classification of the attachment Available from CRM.COM R12.2.0 |
file | File Object | The information of the attached file. This information is empty if the attachment is a URL. |
log_information | Log Information Object | The log information of the retrieved attachment |
Referred Objects Response Data
Name | Type | Description |
id | String | The id of the retrieved attachment classification |
name | String | The name of the retrieved attachment classification |
alternative_code | String | The alternative code of the retrieved attachment classification |
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
code | String | The code of the retrieved business unit |
unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Examples
HTTP Method: GET
Request:
Response:
{ "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" } } ] }
- No labels