GET contact_information/configuration/address_types/list
This method returns the address types that are allowed to be used in the system, as specified in the active contact information definition. Multiple address types are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
code | String | The code of the retrieved address type, that can be one of the following: HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
name | String | The label of the retrieved address type, as configured in the active contact information definition |
| is_supported_for_person | Boolean | Defines if the address type for the contact type PERSON is supported Available from CRM.COM R15.0.0 |
| is_supported_for_company | Boolean | Defines if the address type for the contact type COMPANY is supported Available from CRM.COM R15.0.0 |
| is_mandatory_for_person | Boolean | Defines if the address type for the contact type PERSON is mandatory Available from CRM.COM R15.0.0 |
| is_mandatory_for_company | Boolean | Defines if the address type for the contact type COMPANY is mandatory Available from CRM.COM R15.0.0 |
Examples
HTTP Method: GET
Request:
Response:
GET contact_information/configuration/phone_types/list
This method returns the phone types that are allowed to be used in the system, as specified in the active contact information definition. Multiple phone types are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
code | String | The code of the retrieved phone type, that can be one of the following: LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
name | String | The label of the retrieved phone type, as configured in the active contact information definition |
| is_supported_for_person | Boolean | Defines if the phone type for the contact type PERSON is supported Available from CRM.COM R15.0.0 |
| is_supported_for_company | Boolean | Defines if the phone type for the contact type COMPANY is supported Available from CRM.COM R15.0.0 |
| is_mandatory_for_person | Boolean | Defines if the phone type for the contact type PERSON is mandatory Available from CRM.COM R15.0.0 |
| is_mandatory_for_company | Boolean | Defines if the phone type for the contact type COMPANY is mandatory Available from CRM.COM R15.0.0 |
Examples
HTTP Method: GET
Request:
Response:
GET contact_information/configuration/email_types/list
This method returns the email types that are allowed to be used in the system, as specified in the active contact information definition. Multiple email types are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
code | String | The code of the retrieved email type, that can be one of the following: PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
name | String | The label of the retrieved email type, as configured in the active contact information definition |
| is_supported_for_person | Boolean | Defines if the email type for the contact type PERSON is supported Available from CRM.COM R15.0.0 |
| is_supported_for_company | Boolean | Defines if the email type for the contact type COMPANY is supported Available from CRM.COM R15.0.0 |
| is_mandatory_for_person | Boolean | Defines if the email type for the contact type PERSON is mandatory Available from CRM.COM R15.0.0 |
| is_mandatory_for_company | Boolean | Defines if the email type for the contact type COMPANY is mandatory Available from CRM.COM R15.0.0 |
Examples
HTTP Method: GET
Request:
Response:
GET contact_information/configuration/relation_types/list
This method returns the relation types that are allowed to be used in the system, as specified in the active contact information definition. Multiple relation types are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
code | String | The code of the retrieved contact information relation type, that can be one of the following: FAMILY MEMBER, EXTENDED FAMILY, PARTNER, CLOSE FRIEND, FRIEND, WORK COLLEAGUE, PARTNER COMPANY, CLIENT, EMPLOYER, EMPLOYEE, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
name | String | The label of the retrieved contact information relation type, as configured in the active contact information definition |
| is_supported_for_person | Boolean | Defines if the relation type for the contact type PERSON is supported Available from CRM.COM R15.0.0 |
| is_supported_for_company | Boolean | Defines if the relation type for the contact type COMPANY is supported Available from CRM.COM R15.0.0 |
| is_mandatory_for_person | Boolean | Defines if the relation type for the contact type PERSON is mandatory Available from CRM.COM R15.0.0 |
| is_mandatory_for_company | Boolean | Defines if the relation type for the contact type COMPANY is mandatory Available from CRM.COM R15.0.0 |
Examples
HTTP Method: GET
Request:
Response:
GET contact_information/configuration/categories/list
This method returns the contact information categories that are allowed to be used in the system. Multiple contact information categories are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
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 |
| description | String | The description of the retrieved category |
| parent_id | String | The id of the retrieved category's parent category |
Examples
HTTP Method: GET
Request:
Response:
GET contact_information/configuration/industries/list
This method returns the industries that are allowed to be used in the system. Multiple industries are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
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 |
| description | String | The description of the retrieved industry |
| parent_id | String | The id of the retrieved category's parent industry |
Examples
HTTP Method: GET
Request:
Response:
GET contact_information/configuration/industry_sectors/list
This method returns the industry sectors that are allowed to be used in the system. Multiple industry sectors are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
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 |
| description | String | The description of the retrieved industry sector |
Examples
HTTP Method: GET
Request:
Response: